Skip to main content
POST
Add team members
Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Body

application/json
emails
string<email>[]
required

Emails of the team members to be added in the workspace in array format. Must be valid emails.

Example:
organization_role
string

Role that should be assigned to the new team members. It must be a valid role from the "Roles" section in the settings page. The default is "Standard".

Example:

"Standard"

invited_by
string<email>

Email of the admin sending the invitation. Defaults to the most recent workspace admin if not specified.

Example:

"admin@example.com"

send_invitation_email
enum<string>
default:true

Set to "false" to skip sending invitation emails. Defaults to sending emails if not specified.

Available options:
true,
false

Response

200 - application/json

OK - Users added successfully

message
string
Example:

"Users added successfully"