Skip to main content
POST
/
team-members
Add team members
curl --request POST \
  --url https://{your-subdomain}.neetorecord.com/api/external/v2/team-members \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "emails": [
    "oliver@example.com",
    "jane@example.com"
  ],
  "organization_role": "Standard",
  "invited_by": "admin@example.com",
  "send_invitation_email": "true"
}
'
{
  "message": "Users added successfully"
}
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying 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:
["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"

​
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

201 - application/json

Created - Users added successfully

​
message
string
Example:

"Users added successfully"