Create Envoy invite
curl --request POST \
--url https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"invitation": {
"customFields": [
{
"field": "<string>",
"value": "<string>"
}
],
"expectedArrivalAt": "<string>",
"expectedDepartureAt": "<string>",
"flowId": "<string>",
"hostEmployeeId": "<string>",
"inviteId": "<string>",
"invitee": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"locationId": "<string>",
"notes": "<string>",
"sendEmailToInvitee": true
}
}
'import requests
url = "https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite"
payload = { "invitation": {
"customFields": [
{
"field": "<string>",
"value": "<string>"
}
],
"expectedArrivalAt": "<string>",
"expectedDepartureAt": "<string>",
"flowId": "<string>",
"hostEmployeeId": "<string>",
"inviteId": "<string>",
"invitee": {
"email": "<string>",
"id": "<string>",
"locationIds": ["<string>"],
"locations": ["<string>"],
"name": "<string>",
"type": "<string>"
},
"locationId": "<string>",
"notes": "<string>",
"sendEmailToInvitee": True
} }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
invitation: {
customFields: [{field: '<string>', value: '<string>'}],
expectedArrivalAt: '<string>',
expectedDepartureAt: '<string>',
flowId: '<string>',
hostEmployeeId: '<string>',
inviteId: '<string>',
invitee: {
email: '<string>',
id: '<string>',
locationIds: ['<string>'],
locations: ['<string>'],
name: '<string>',
type: '<string>'
},
locationId: '<string>',
notes: '<string>',
sendEmailToInvitee: true
}
})
};
fetch('https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invitation\": {\n \"customFields\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"expectedArrivalAt\": \"<string>\",\n \"expectedDepartureAt\": \"<string>\",\n \"flowId\": \"<string>\",\n \"hostEmployeeId\": \"<string>\",\n \"inviteId\": \"<string>\",\n \"invitee\": {\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"locationIds\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"locationId\": \"<string>\",\n \"notes\": \"<string>\",\n \"sendEmailToInvitee\": true\n }\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Service Management Integrations Webservice
Create Envoy invite
Create an invite with Envoy
POST
/
api
/
integrations
/
serviceManagement
/
createEnvoyInvite
Create Envoy invite
curl --request POST \
--url https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"invitation": {
"customFields": [
{
"field": "<string>",
"value": "<string>"
}
],
"expectedArrivalAt": "<string>",
"expectedDepartureAt": "<string>",
"flowId": "<string>",
"hostEmployeeId": "<string>",
"inviteId": "<string>",
"invitee": {
"email": "<string>",
"id": "<string>",
"locationIds": [
"<string>"
],
"locations": [
"<string>"
],
"name": "<string>",
"type": "<string>"
},
"locationId": "<string>",
"notes": "<string>",
"sendEmailToInvitee": true
}
}
'import requests
url = "https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite"
payload = { "invitation": {
"customFields": [
{
"field": "<string>",
"value": "<string>"
}
],
"expectedArrivalAt": "<string>",
"expectedDepartureAt": "<string>",
"flowId": "<string>",
"hostEmployeeId": "<string>",
"inviteId": "<string>",
"invitee": {
"email": "<string>",
"id": "<string>",
"locationIds": ["<string>"],
"locations": ["<string>"],
"name": "<string>",
"type": "<string>"
},
"locationId": "<string>",
"notes": "<string>",
"sendEmailToInvitee": True
} }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
invitation: {
customFields: [{field: '<string>', value: '<string>'}],
expectedArrivalAt: '<string>',
expectedDepartureAt: '<string>',
flowId: '<string>',
hostEmployeeId: '<string>',
inviteId: '<string>',
invitee: {
email: '<string>',
id: '<string>',
locationIds: ['<string>'],
locations: ['<string>'],
name: '<string>',
type: '<string>'
},
locationId: '<string>',
notes: '<string>',
sendEmailToInvitee: true
}
})
};
fetch('https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/integrations/serviceManagement/createEnvoyInvite")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invitation\": {\n \"customFields\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"expectedArrivalAt\": \"<string>\",\n \"expectedDepartureAt\": \"<string>\",\n \"flowId\": \"<string>\",\n \"hostEmployeeId\": \"<string>\",\n \"inviteId\": \"<string>\",\n \"invitee\": {\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"locationIds\": [\n \"<string>\"\n ],\n \"locations\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"locationId\": \"<string>\",\n \"notes\": \"<string>\",\n \"sendEmailToInvitee\": true\n }\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
Show child attributes
Show child attributes
Last modified on August 9, 2026
⌘I