Create Invite

Creates a single user's invite. By default, the API will send an email to the invitee. You can use the optional query parameter sendEmail with a value false or 0 to not send an email to the invitee.

Example: ?sendEmail=false

Body: raw JSON

namedescription
inviteeName[string] The first name and the last name being invited, separated with a space.
inviteeEmail[string] Required. Valid email of the user being invited.
entityZUID[string] Required. ZUID of the instance the invitee to be added to.
accessLevel[int] Required. The system role the invitee will have. This accepts values from 1 to 5 only. See below for acceptable values.

Access Level

coderole
1Admin
2Developer
3SEO
4Publisher
5Contributor
6Developer Contributor
7Access Admin

Note: If any of these role are not available in an instance, contact support.

Query Params
string

Optional. Should the API send an email.

Body Params

Invite object to create

integer
required
string
required
string
required
string
Responses

Language
Credentials
Header
Response
Choose an example:
application/json