Create a user

Overview

The "Create a user" API allows users to create new organization members.

Usage

Base URL

https://<organization>.neetocal.com/api/external/v1

Replace the <organization> with the desired organization's subdomain.

Endpoint

POST /users

Request 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
organization_role	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".
emails	Array	Yes	An array of email ids that will be created as users in your organization. Must be valid emails.

Example

For creating a user with the email [email protected] and a role of Admin in the organization "Spinkart" with subdomain spinkart using curl

curl --request POST \
  --url 'https://spinkart.neetocal.com/api/external/v1/users' \
  --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