Invite User

Invite a user by email address

Path parameters

site_idstringRequiredformat: "uuid"
Unique identifier for a Site

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Accept-VersionstringOptional
The API version

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
Email address of user to send invite to
accessGroupslist of stringsOptional

An array of access group slugs. Access groups are assigned to the user as type admin and the user remains in the group until removed.

Response

Request was successful
_idstring or nullformat: "uuid"
Unique identifier for the User
createdOnstring or nullformat: "date-time"
The timestamp the user was created
updatedOnstring or nullformat: "date-time"
The timestamp the user was updated
invitedOnstring or nullformat: "date-time"
The timestamp the user was invited
lastLoginstring or nullformat: "date-time"
The timestamp the user was logged in
emailVerifiedboolean or null
Shows whether the user has verified their email address
statusenum or null
The status of the user
Allowed values:
accessGroupslist of objects or null
Access groups the user belongs to
dataobject or null
An object containing the User's basic info and custom fields

Errors