User Admin Invitations

The users endpoint supports operations to send administrator invitations to users.

User invitations data model

Property Type Required? Mutable? Description

Property	Type	Required?	Mutable?	Description
`invite.acceptUrl`	String	Optional	Mutable	The URL where the invited user can accept the invitation.
`invite.expirationMinutes`	String	Optional	Mutable	How long the invite is valid for, represented in minutes.
`invite.isAdmin`	Boolean	Required	Mutable	Indicates if the invitation is an admin invitation.

invite.acceptUrl

String

Optional

Mutable

The URL where the invited user can accept the invitation.

invite.expirationMinutes

String

Optional

Mutable

How long the invite is valid for, represented in minutes.

invite.isAdmin

Boolean

Required

Mutable

Indicates if the invitation is an admin invitation.

For more user property descriptions, refer to the Users data model.

Code	Message
200	Successful operation.
204	Successfully removed. No content.
400	The request could not be completed.
401	You do not have access to this resource.
404	The requested resource was not found.