Skip to content

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

POST
/organization/invites

Authorizations

Request Body required

The invite request payload.

object
email
required

Send an email to this address

string
role
required

owner or reader

string
Allowed values: reader owner

Responses

200

User invited successfully.

Represents an individual invite to the organization.

object
object
required

The object type, which is always organization.invite

string
Allowed values: organization.invite
id
required

The identifier, which can be referenced in API endpoints

string
email
required

The email address of the individual to whom the invite was sent

string
role
required

owner or reader

string
Allowed values: owner reader
status
required

accepted,expired, or pending

string
Allowed values: accepted expired pending
invited_at
required

The Unix timestamp (in seconds) of when the invite was sent.

integer
expires_at
required

The Unix timestamp (in seconds) of when the invite expires.

integer
accepted_at

The Unix timestamp (in seconds) of when the invite was accepted.

integer