POST - Add a user to the Organization
Purpose
The API adds the specified user to the particular Organization.
Request URL
https://mail.zoho.com/api/organization/<zoid>/accounts
Scope
organization.accounts
Request Parameters
Parameter | Data Type | Description |
zoid | Integer | The unique Zoho Organization Identifier for the organization |
* - Mandatory parameters
Request Body (JSON Object)
Parameter | Data Type | Allowed Values | Description |
primaryEmailAddress* | String | - | Provide the domain based email address which should be the primary email address for the user to be created |
password* | String | - | Provide the password for the user to be created |
displayName | String | - | Enter the display name that you want to assign to the user |
role | String | member admin | Assign a role for the user to be created |
country | String | - | Enter the country the user works from |
language | String | - | Enter a choice of language for the user |
timeZone | String | - | Enter the timezone the user works from |
groupMailList | JSON Array | - | Enter the groups email addresses to which the user needs to be added |
oneTimePassword | Boolean | true false | Mention whether the password that you have provided for the user is a one time password. If so, the user will be asked to change the password on first login |
* - Mandatory parameters
Response Codes
Please refer Response Codes.
Sample Request
{
"role": "member",
"primaryEmailAddress": "newuser1@mybizemail.com",
"timeZone": "Asia/Kolkata",
"language": "En",
"displayName": "New User 1",
"password": "Abc@123",
"country": "in",
"groupMailList": ["newgroupmail@mybizemail.com","newgroup@mybizemail.com"]
}