API Docs
/
No Results Found
Users

Users

Users are various individuals/entities that are a part of an organisation. Each user will have a different role to play, like admin, staff etc., .

Create a user

Create a user for your organization.
oauthscope : ZohoBooks.settings.CREATE

Arguments

name
string
(Required)
name of the user
email
string
(Required)
email address of the user
role_id
string
cost_rate
double
Hourly cost rate

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users -X POST -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "name": "Sujin Kumar", "email": "johndavid@zilliuminc.com", "role_id": "982000000006005", "cost_rate": 0 }

Response Example

{ "code": 0, "message": "Your invitation has been sent." }

List Users

Get the list of all users in the organization.
oauthscope : ZohoBooks.settings.READ

Query Parameters

filter_by
Allowed Values: Status.All, Status.Active, Status.Inactive, Status.Invited and Status.Deleted
sort_column
Sort users. Allowed Values: name, email, user_role and status

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "users": [ { "user_id": "982000000554041", "role_id": "982000000006005", "name": "Sujin Kumar", "email": "johndavid@zilliuminc.com", "user_role": "admin", "status": "active", "is_current_user": true, "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb", "is_customer_segmented": false, "is_vendor_segmented": false, "user_type": "zoho" }, {...}, {...} ], "page_context": { "page": 1, "per_page": 10, "has_more_page": false, "report_name": "Users", "sort_column": "name", "sort_order": "A" } }

Update a user

Update the details of a user.
oauthscope : ZohoBooks.settings.UPDATE

Arguments

name
string
(Required)
name of the user
email
string
(Required)
email address of the user
role_id
string
cost_rate
double
Hourly cost rate

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/{user_id} -X PUT -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "name": "Sujin Kumar", "email": "johndavid@zilliuminc.com", "role_id": "982000000006005", "cost_rate": 0 }

Response Example

{ "code": 0, "message": "The user information has been updated." }

Get a user

Get the details of a user.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/{user_id}

Response Example

{ "code": 0, "message": "success", "user": { "user_id": "982000000554041", "name": "Sujin Kumar", "email_ids": [ { "email": "johndavid@zilliuminc.com", "is_selected": true } ], "status": "active", "user_role": "admin", "user_type": "zoho", "role_id": "982000000006005", "cost_rate": 0, "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb", "is_employee": true, "created_time": "2016-06-05T02:30:08-0700", "custom_fields": "" } }

Delete a user

Delete a user associated to the organization.
oauthscope : ZohoBooks.settings.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/{user_id} -X DELETE

Response Example

{ "code": 0, "message": "The user has been removed from your organization." }

Get current user

Get the details of the current user.
oauthscope : ZohoBooks.settings.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/me

Response Example

{ "code": 0, "message": "success", "user": { "user_id": "982000000554041", "name": "Sujin Kumar", "email_ids": [ { "email": "johndavid@zilliuminc.com", "is_selected": true } ], "status": "active", "user_role": "admin", "user_type": "zoho", "role_id": "982000000006005", "cost_rate": 0, "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb", "is_employee": true, "created_time": "2016-06-05T02:30:08-0700", "custom_fields": "" } }

Invite a user

Send invitation email to a user.
oauthscope : ZohoBooks.settings.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/{user_id}/invite -X POST

Response Example

{ "code": 0, "message": "Your invitation has been sent." }

Mark user as active

Mark an inactive user as active.
oauthscope : ZohoBooks.settings.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/{user_id}/active -X POST

Response Example

{ "code": 0, "message": "The user has been marked as active." }

Mark user as inactive

Mark an active user as inactive.
oauthscope : ZohoBooks.settings.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/users/{user_id}/inactive -X POST

Response Example

{ "code": 0, "message": "The user has been marked as inactive." }