Add Staff

Table of Contents

Purpose

To add staff to your Zoho Bookings account. This can be done by the admin and Super admin.

Request URL

https://www.zohoapis.com/bookings/v1/json/addstaff

Headers

Parameter NameDescription
AuthorizationZoho-oauthtoken {{accesstoken}}

Note: The access token can be generated from the developer console.

Request Method

POST

Parameters

Input has to be given in the body form-data as key-value pair.

Key : staffMap

Value : Refer sample request on the right side

Parameter NameDescription
name *The name of the staff
email *The email id of the staff
genderThe gender of the staff
role

The role of the staff. It can take any of the these values - Admin, Manager, Staff.

 

dob

The date of birth of the staff

format: dd-MMM-yyyy HH:mm:ss (e.g. 30-Apr-2019 22:00:00)

(or)

dd-MMM-yyyy hh:mm:ss (e.g. 30-Apr-2019 10:00:00 PM)

additional infoThe additional information about the staff
phoneThe phone number of the staff
designationThe designation of the staff
assigned_services

The services that the staff has been assigned to. You can send a single service or a list of services in the below format.

["service_id"] (OR) ["service_id_1", service_id_2"]

Note: fields marked * are mandatory.

Response Type

JSON

Possible Errors

1. Mandatory fields missing in the request

Error description

Name and email fields are mandatory

Suggested Action

Please set values for all mandatory fields.

2. Adding staff who already exist

Error description

If you try to add the staff who already exist, then you will get the response as "Staff already exists".

Suggested Action

Please check if the staff already exist in your account.

3. Attempt to add more than 50 staff at a time

Error description

If you add more than 50 staff at a time, then you will get the response as "Can't add more than 50 staff at once".

Suggested Action

Please add only 50 staff at a time. Add the remaining staff in another request.

4. The staff limit has reached

Error description

If you add staff beyond the user counts allowed for your account, then you will get the response as "Can't add more staff. Staff limit for the account reached".

Suggested Action

Kindly upgrade your account to add more staff.

API Limits

Zoho Bookings Plan/EditionNumber of API calls/day
Free250/per user
Basic1000/per user
Premium3000/per user
Zoho One3000/per user
Note: The API limits are excluding the authorization requests. API counts are calculated between 00:00 and 23:59 hours in the respective time zones.

Related Links

Sample Request

CopiedKEY : staffMap
VALUE :
{
  "data" :
  [
{
"name":"Test1",
 "email":"test1@test.com",
 "gender":"Female",
 "role":"Admin",
 "dob":"12-Aug-1999 00:00:00",
 "additional_info":"Testing",
 "phone":"1234567890",
 "designation":"Developer",
 "assigned_services":["82045000000112024","82045000000098220"]
}
]
}

Sample Response

Copied{
"response":[
          		      {
             "id":"82045000000197016",
             "name":"Test1",
             "email":"test1@test.com",
             "status":"success”
           		    }
]
}