Add a User

This API allows you to add or invite a new user to your account. In the sample request, you'd have to specify the user's email address and name.

Request Type

  • POST

Request URL

https://campaigns.zoho.com/emailapi/v2/settings/users

Content-Type

application/json

List of Request Body Attributes

ParametersData TypeDescription
email_idStringEmail address of the user.
user_nameStringName of the user.

List of Response Body Attributes

ParametersData TypeDescription
responseJSON ObjectContains the response details of the API.
codeIntegerSuccess or failure code.
messageStringSuccess or failure message returned by the API.
errorsJSON ObjectContains the error details of the API such as 'code' and 'message'.

Possible Errors

Error CodeDescription
400603User already exists.
400604User already invited.
400605User limit reached. You can't add users anymore.
Run in PostmanView Collection

Sample Request Payload

Copied{
  "email_id": "siegfried@zylker.com",
  "user_name": "Siegfried"
}

Sample Response - Success

Copied{
  "response": {
    "code": 200607,
    "message": "An invitation has been sent to the user"
  }
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 500601,
      "message": "An error occurred in User Management"
    }
  ]
}