UsersUsers

Create and Invite a User

Create and invite a user with an email address.

The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.

Required scope | users:write

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Headers

AuthorizationstringRequired

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

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

idstringOptionalformat: "objectid"

Unique identifier for the User

isEmailVerifiedbooleanOptional

Shows whether the user has verified their email address

lastUpdatedstringOptionalformat: "date-time"

The timestamp the user was updated

invitedOnstringOptionalformat: "date-time"

The timestamp the user was invited

createdOnstringOptionalformat: "date-time"

The timestamp the user was created

lastLoginstringOptionalformat: "date-time"

The timestamp the user was logged in

statusenumOptional

The status of the user

Allowed values:
accessGroupslist of objectsOptional

Access groups the user belongs to

dataobjectOptional

An object containing the User’s basic info and custom fields

Errors