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
idstring or nullformat: "objectid"
Unique identifier for the User
isEmailVerifiedboolean or null
Shows whether the user has verified their email address
lastUpdatedstring or nullformat: "date-time"
The timestamp the user was updated
invitedOnstring or nullformat: "date-time"
The timestamp the user was invited
createdOnstring or nullformat: "date-time"
The timestamp the user was created
lastLoginstring or nullformat: "date-time"
The timestamp the user was logged in
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