Skip to main content
POST
cURL
Invites up to 50 people to the workspace by email. The invite email is sent on behalf of the person who created the API key. Each email gets its own outcome:
  • invited: an invite was created, the user joins the workspace when they accept it.
  • added: the email already has a Claap account, the user was added to the workspace right away.
  • already_member: the email is already an active user of the workspace.
  • failed: the email could not be invited, for instance because it is not valid, the user is suspended, or the invite limit is reached for that workspace. error explains why.

Authorizations

X-Claap-Key
string
header
required

Body

application/json
emails
string<email>[]
required

Emails to invite.

Required array length: 1 - 50 elements
role
enum<string>
default:Member

Role given to the invited users. On a workspace without an active subscription, users are always invited as Owner.

Available options:
Member,
Admin,
Owner
userGroupIds
string[]

User groups the invited users join.

message
string

Personal message added to the invite email.

Response

Invites were processed

result
object
required