Users API
Scope: ZohoBugTracker.users.{Operation}
Operations: READ, CREATE, UPDATE, DELETE, ALL
Use the ALL operation to gain the scope for all the other operations like READ, CREATE, UPDATE, and DELETE at once.
| Get project users GET /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/ |
| Add Users to a Project POST /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/ |
| Add Users to a Portal POST /restapi/portal/[PORTALID]/users/ |
| Update Users in a Project POST /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/[USERID]/ |
| Delete User from a Project DELETE /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/[USERID]/ |
| Get remaining no. of users in a portal GET /restapi/portal/[PORTALID]/users/availcount/ |
| Get portal users GET /restapi/portal/[PORTALID]/users/ |
| Delete User from a Portal DELETE /restapi/portal/[PORTALID]/users/[USERID]/ |
| Activate user POST /restapi/portal/[PORTALID]/users/activate/ |
| Deactivate user POST /restapi/portal/[PORTALID]/users/activate/ |
| Add user to a client company POST /restapi/portal/[PORTALID]/clients/[CLIENT_COMPANY_ID]/users |
Get project users
Gets the details of all the users in a specific project.
GET /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/
Scope: ZohoBugTracker.users.READ
Request Parameters
| user_type | String | Availability status of the user. Allowed values:
|
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"users": [{
"id": "2060758",
"name": "Patricia Boyle",
"active": true,
"email": "patriciab@zillum.com",
"role": "admin"
}, {
"id": "2060761",
"name": "Einhard Klein",
"active": false,
"email": "dieterk@zillum.com",
"role": "manager"
}, {
"id": "2063348",
"name": "Charles Stone",
"active": true,
"email": "charless@zillum.com",
"role": "employee"
}, {
"id": "2063354",
"name": "Nathan Brooks",
"active": true,
"email": "nbrooks@zillum.com",
"role": "contractor"
}]
}Add Users to a Project
Adds users to a specific project.
POST /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/
Scope: ZohoBugTracker.users.CREATE
Request Parameters
| String | Email ID of users separated by a comma. | |
| role | String | Role of the user (manager, employee, contractor). |
| rate | Float | The rate per hour set for a specific user in a project based on staff based billing. Example: 20.750 |
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"users": [{
"id": "2060758",
"name": "Patricia Boyle",
"email": "patriciab@zillum.com",
"role": "employee",
"rate": "20.750"
}]
}Add Users to a Portal
Adds users to a portal.
POST /restapi/portal/[PORTALID]/users/
Scope: ZohoBugTracker.users.CREATE
Request Parameters
| String | Email ID of users separated by a comma. | |
| profileid | String | Profile ID of the user to be added |
| roleid | String | Role ID of the user. |
| work_projects | Long | Multiple project IDs separated by comma. |
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"users": [
{
"role_name": "Manager",
"zpuid": "170876000011876001",
"profile_name": "Manager",
"role": "Manager",
"profile_type": "6",
"role_id": "170876000004915003",
"profile_id": "170876000004602140",
"name": "albaflores",
"active": true,
"id": "756839327",
"email": "albaflores@zillum.com"
}
]
}
}Update Users in a Project
Updates the details of a specific user in a project.
POST /restapi/portal/[PORTALID]/projects/[PROJECTID]/users/[USERID]/
Scope: ZohoBugTracker.users.UPDATE
Request Parameters
| role | String | Role of the user (manager, employee, contractor). |
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"users": [{
"id": "2060758",
"name": "Patricia Boyle",
"email": "patriciab@zillum.com",
"role": "employee",
"rate": "20.750"
}]
}Delete User from a Project
Deletes the user from a project.
DELETE /restapi/portal/[PORTALID]/project/[PROJECTID]/users/[USERID]/
Scope: ZohoBugTracker.users.DELETE
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"response": "User Deleted Successfully"
}Get remaining no. of users in a portal
Fetches the remaining no. of users to be added in a specific portal.
GET /restapi/portal/[PORTALID]/users/availcount/
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"available_user_count": "1"
}Get portal users
Gets the details of all users in a specific portal.
GET /restapi/portal/[PORTALID]/users/
Scope: ZohoBugTracker.users.READ
Request Parameters
| user_type | String | Availability status of the user. Allowed values:
|
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"users": [
{
"role_name": "Manager",
"profile_name": "manager",
"role": "manager",
"profile_type": "6",
"role_id": "170876000004915003",
"profile_id": "170876000004602140",
"name": "Patricia Boyle",
"active": true,
"id": "923962",
"invoice": "60.000",
"email": "patricia.b@zylker.com",
"currency_code": "USD"
},
{
"role_name": "Administrator",
"profile_name": "admin",
"role": "admin",
"profile_type": "2",
"role_id": "170876000004915001",
"profile_id": "170876000004602137",
"name": "Eduardo Vargas",
"active": true,
"id": "2060557",
"invoice": "40.000",
"email": "eduardov@zillum.com",
"currency_code": "USD"
},
{
"role_name": "Employee",
"profile_name": "employee",
"role": "employee",
"profile_type": "7",
"role_id": "170876000004915005",
"profile_id": "170876000004602143",
"name": "Jasmine Frank",
"active": true,
"id": "2060559",
"invoice": "0.000",
"email": "jasminef@zillum.com",
"currency_code": "USD"
},
{
"role": "client",
"profile_type": 3,
"client_company_name": "Universal Events",
"client_company_id": "170876000003941041",
"currency_code": "USD",
"role_name": "Client",
"profile_name": "client",
"role_id": "170876000004915009",
"profile_id": "170876000004602149",
"name": "david.henry",
"id": "636378540",
"invoice": "80.000",
"email": "david.henry@yahoo.com"
}
]
}Delete User from a Portal
Deletes the user from a portal.
DELETE /restapi/portal/[PORTALID]/users/[USERID]/
Scope: ZohoBugTracker.users.DELETE
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"status": "success"
}
Activate user
Activates a specific user in a specific portal.
POST /restapi/portal/[PORTALID]/users/activate/
Scope: ZohoBugTracker.users.CREATE
Request Parameters
| activate | Long | User ID |
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"response": "User Activated Successfully"
}Deactivate user
Deactivates a specific user from a specific portal.
POST /restapi/portal/[PORTALID]/users/activate/
Scope: ZohoBugTracker.users.CREATE
Request Parameters
| deactivate | Long | User ID |
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"response": "User Deactivated Successfully"
}Add user to a client company
Adds user to an existing client company.
POST /restapi/portal/[PORTALID]/clients/[CLIENT_COMPANY_ID]/users
Scope: ZohoBugTracker.users.CREATE
Request Parameters
| contact_email* | String | Email ID of the client user. |
| work_projects | Long | Multiple project IDs are separated using comma. |
| profile_id | Long | Specify Profile ID. profile_id is obtained from Get Portal Users API. |
| invoice_rate | Double | Specify an invoice rate. Example 50.000 |
Note:
- CLIENT_COMPANY_ID is obtained from Get Portal Users API.
Sample Response
Status: 200 Success Content Type: application/json;charset=utf-8
{
"clients": [
{
"crm_account_id": "",
"associated_projects": [
{
"name": "Budgetting",
"id": 170876000000008000
},
{
"name": "Logistics",
"id": 170876000000307040
},
{
"name": "Project Analysis",
"id": 170876000000531420
}
],
"name": "Zoho ",
"id": 170876000005492320,
"users": [
{
"associated_projects": [
{
"name": "Budgetting",
"id": 170876000000008000
},
{
"name": "Logistics",
"id": 170876000000307040
}
],
"name": "Patricia Boyle",
"id": "668495355",
"email": "patricia.b@zylker.com",
"crm_contact_id": ""
}
]
}
]
}