Overview
The "Create a team member" API allows users to create new team members in the workspace.
Usage
Base URL
https://<workspace>.neetocal.com/api/external/v1Replace the <workspace> with your workspace's subdomain.
Endpoint
POST /team_membersRequest header
This endpoint requires authentication. You must include a valid API key in the request header.
Header |
Type |
Required |
Description |
|---|---|---|---|
X-Api-Key |
String |
Yes |
Bearer token for API access. |
Request body
Key |
Type |
Required |
Description |
|---|---|---|---|
|
String |
No |
The role that should be assigned to the newly created user. It must be a valid role from the "Roles" section in the settings page. The default is "Standard". |
|
Array |
Yes |
An array of email ids that will be created as team members in your workspace. Must be valid emails. |
Example
For creating a user with the email [email protected] and a role of Admin in the workspace "Spinkart" with subdomain spinkart using curl
curl --request POST \
--url 'https://spinkart.neetocal.com/api/external/v1/team_members' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"organization_role": "Admin",
"emails": ["[email protected]"]
}'Response Codes
Code |
Description |
|---|---|
200 |
OK - Request succeeded |
401 |
Unauthorized - Invalid API key |
500 |
Internal server error |