Skip to main content
View as Markdown

Invite a new member to the organization

POST/api/v1/organizations/{id}/invitations

Creates a pending invitation for an email with the given role. Admin only. Fails if the email already belongs to a member or already has a pending invitation.

Path parameters
idintegerrequired
Organization id
Body parameters
emailstring · emailrequired
rolestringrequired
Organization role. admin: manage members and billing, plus everything readwrite can do. readwrite: start sessions, create API keys, delete sessions. readonly: view sessions, API keys, and test results only.
Returns
idstring · uuidrequired
emailstring · emailrequired
rolestringrequired
Organization role. admin: manage members and billing, plus everything readwrite can do. readwrite: start sessions, create API keys, delete sessions. readonly: view sessions, API keys, and test results only.
statusstringrequired
inviterstring · uuidnullable
Reference to the inviting user
createdAtstring · date-timerequired
expiresAtstring · date-timenullable