POST /invitations

🔗 latest documentation

Authorization: API token with at least Superuser permissions.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

host String No

Request body fields

Name Type Required Description
data Object No
data.attributes Object No
data.attributes.email String No
data.attributes.limit_services Boolean No
data.attributes.role String No
data.type String No
data.relationships Object No
data.relationships.customer Object No
data.relationships.customer.data Object No
data.relationships.customer.data.id String No
data.relationships.customer.data.type String No
data.relationships.service_invitations Object No
data.relationships.service_invitations.data[] Array No
data.relationships.service_invitations.data[].attributes Object No
data.relationships.service_invitations.data[].attributes.permission String No
data.relationships.service_invitations.data[].type String No
data.relationships.service_invitations.data[].relationships Object No
data.relationships.service_invitations.data[].relationships.service Object No
data.relationships.service_invitations.data[].relationships.service.data Object No
data.relationships.service_invitations.data[].relationships.service.data.id String No
data.relationships.service_invitations.data[].relationships.service.data.type String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.