Skip to main content
POST
/
team_members
Add team members
curl --request POST \
  --url https://{your-workspace}.neetodesk.com/api/external/v1/team_members \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{
  "organization_role": "Standard",
  "emails": [
    "oliver@example.com",
    "jane@example.com"
  ]
}'
{
  "message": "Users added successfully"
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json
​
emails
string[]
required

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

Example:
["oliver@example.com", "jane@example.com"]
​
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"

Response

200 - application/json

OK - Users added successfully

​
message
string
Example:

"Users added successfully"