Invitations

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. This feature is part of a Limited Availability release.

Fields

field

type

description

data.type

string

'invitation'

data.id

string

Unique ID of the invitation.

data.attributes.created_at

string

Time-stamp (GMT) indicating when the invitation was created. Read Only.

data.attributes.deleted_at

string

Time-stamp (GMT) indicating when the invitation was deleted. Read Only.

data.attributes.email

string

The email address of the invitee.

data.attributes.role

string

The user-assigned permissions role. Can be user, billing, engineer, or superuser.

data.attributes.status_code

boolean

Indicates whether or not the invite is active, with 0 representing inactive and 1 representing active.

data.attributes.updated_at

string

Time-stamp (GMT) indicating when the invitation was updated. Read Only.