Skip to main content
POST
Invite someone to the workspace

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

Body

application/json
email
string<email>
required

Email address to invite.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
enum<string>
required

Workspace role on joining. "member" is shown as Creator in the product.

Available options:
member,
collaborator
teams
object[]

Teams the invitee joins on accepting.

expiresInDays
integer

Days until the invitation expires. Defaults to 7.

Required range: 1 <= x <= 90

Response

Invitation created and emailed.

id
string
required
type
string
required
email
string
required
customerId
string
required
status
string
required

"pending" or "expired" — only those two are listed.

createdAt
string
required

ISO 8601 timestamp.

expiresAt
string
required

ISO 8601 timestamp.

customerName
string
customerRole
string

The role the invitee gets on accepting.

isExpired
boolean
invitedByUserName
string
displayName
string
groups
object[]
agentAccess
object

Set on guest invitations created from an agent's access page.

{key}
any