Add a new user to the organization

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Creates a new user account in the cloud organization with the specified role, username, and email. The user receives an invitation email immediately upon creation.

Endpoints

Request URL

https://{serverurl}/dcapi/users-cloud

Scope

DesktopCentralCloud.Admin.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

content-typestringMandatory
application/userAddition.v1+jsonapplication/userAddition.v1+jsonCopied!

Specifies the request payload format. Set to application/userAddition.v1+json to submit the user data in JSON format.

- Request Body

application/json
JSON Object
Hide Sub-Attributes
mailIDstringMandatory

Email address of the user. This will be used for user communication and login.

userNamestringMandatory

Unique username for the user. This will be used for login credentials.

roleIDstringMandatory

Role identifier to assign to the user. To get available role IDs, use this API. Get Role ID

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/users-cloud \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/userAddition.v1+json' \
  --data '{"roleID":"9502000000014452","mailID":"john.smith@example.com","userName":"john.smith"}'

Sample Request Body

Create a new cloud user with email, username, and assigned role.

Copied!
  {
    "roleID": "9502000000014452",
    "mailID": "john.smith@example.com",
    "userName": "john.smith"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
loginIDstring

Unique login identifier assigned to the newly created user.

statusMsgstring

confirmation message for the create-user operation.

newUserboolean

Indicates whether the created user is a newly invited user (true) or an existing user (false).

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Application-specific error code indicating the reason for the request failure.

errorMsgstring

Error message describing the cause of the error.

Possible Response Codes

200HTTP code
400HTTP code

Sample Response: HTTP 200

Successful create user response with assigned login ID and confirmation.

Copied!
  {
    "loginID": "9502000000122681",
    "statusMsg": "User john.smith has been invited successfully",
    "newUser": true
  }
                
Show full

Sample Response: HTTP 400

Error response when attempting to create a user with an email address that already exists.

Copied!
  {
    "errorCode": "1107",
    "errorMsg": "User johny@zohocorp.com already exists"
  }
                
Show full

Error response when the user name is null or empty.

Copied!
  {
    "errorCode": "1103",
    "errorMsg": "UserName Should not be null or empty"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.