Skip to main content
POST
Invite a member
Sends an invitation by email. Admin keys only. A member key returns 403 admin_key_required. When the email does not send, the response still has invite_link to share yourself.

Authorizations

Authorization
string
header
required

Workspace API key. Create one in Settings → API keys.

Body

application/json
email
string<email>
required
role
enum<string>
default:member
Available options:
admin,
member,
viewer

Response

The invitation.

invitation
object
email_sent
boolean
email_error
string

Present when the email did not send. Share invite_link instead.