Invitations allow superusers and engineers to invite users to set up accounts as collaborators under a main customer account. Superusers can invite collaborators and assign them any role or permission level on a per-service basis. Engineers with no per-service limitations on their role can only invite new collaborators but cannot modify their permissions.

Data model

emailstringThe email address of the invitee.
limit_servicesbooleanIndicates the user has limited access to the customer's services.
rolestringThe permissions role assigned to the user. Can be user, billing, engineer, or superuser.
status_codeintegerIndicates whether or not the invitation is active.
typestringResource type. [Default invitation]
created_atstringDate and time in ISO 8601 format. Read-only.
deleted_atstringDate and time in ISO 8601 format. Read-only.
idstringAlphanumeric string identifying an invitation. Read-only.
relationships.customer.idstringAlphanumeric string identifying the customer.
updated_atstringDate and time in ISO 8601 format. Read-only.


List invitations


Create an invitation


Delete an invitation