Skip to main content
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
  }
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json
invitation
object

Response

200 - application/json

OK

Base response object denoting success, or failure with a reason, for an endpoint.

error
boolean | null
errorMsg
string | null
warningMsg
string | null