Skip to main content
POST
Invite New User

Body

user
object
required

Response

success
boolean
required
Wheter or not the invitation was successfully created
message
string
required
The response message
receiver_email
string
required
The email address that the invitation was addressed to
team_group_id
integer
required
The team group id that the user was invited to
user_role
string
required
The role that the new user was invited with
invitation_status
string
required
The invitation’s status. Valid values are pending, accepted, or expired.
expires_at
string
required
The date & time when the invitation will expire (in ISO 8601 format).