Skip to main content
POST
Invite user to a teamspace

Authorizations

Authorization
string
header
required

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

Path Parameters

teamspace_id
string
required

The ID of the teamspace

Body

application/json

Represents a user in a teamspace

email
string<email>
required

The email address of the user to invite

permissions
object | null

The permissions to assign to the user in the teamspace

Response

User invited successfully

Represents a invite for a user in a teamspace

id
string
required

The ID of the invite. Only present if the invite is pending.

email
string<email>
required

The email address of the user invited

permissions
object
required

Represents the permissions assigned to a user in a teamspace

status
enum<string>
required

Whether the user has accepted the invite

Available options:
pending,
accepted
accepted_at
string<date-time> | null

The date and time the user accepted the invite. Only present if the invite is accepted.