Create Customer
Table of Contents
Purpose
To create a new customer in Zoho Bookings.
Customers created using this API are added as Guest customers by default.
Request URL
https://www.zohoapis.com/bookings/v1/json/addcustomer
Headers
| Parameter Name | Description |
|---|---|
| Authorization | Zoho-oauthtoken {{accesstoken}} |
Note: The access token can be generated from the developer console.
Scope
zohobookings.data.CREATE
Request Method
POST
Parameters
Parameters to be passed in the request body as form-data along with the request URL are,
| Parameter Name | Description |
|---|---|
| customerMap* | The map containing the details to be updated. Refer to the below parameters. |
| name* or first_name* last_name* | Name of the customer or First name of the customer Last name of the customer |
| Email address of the customer | |
| contact_number | Phone number of the customer |
Note: Fields marked with * are mandatory.
When an array of customer data is passed, the API performs a bulk create.
Response Type
JSON
Points to consider
- Add limit: You can add to 10 customers in a single request.
- Mandatory fields: Values must be provided for all mandatory fields. It depends on the configuration under Customers → Manage Customer Fields.
- Name field configuration: By default, the Name field or FirstName/LastName is mandatory. If the Name field is configured as a single name, value must be passed only for the name field. But if the Name field is configured as First Name and Last Name, then values must be passed for both first_name and last_name. This configuration can be managed under Customers → Manage Customer Fields.
API Limits
| Zoho Bookings Plan | Number of API calls/day |
| Free | 250 / per user |
| Basic | 1000 / per user |
| Premium | 3000 / per user |
| Zoho One | 3000 / per user |
Note: API limits exclude authorization requests. Counts are calculated between 00:00 and 23:59 in the respective time zone.
Related Links
Sample Request
Copied{
"data": [
{
"name": "Peter John",
"email": "peter.john@zylker.com",
"contact_number": "+11345678901"
},
{
"name": "William Jones",
"email": "william.jones@zylker.com",
"contact_number": "+11345678902"
},
{
"name": "Sophia Brown",
"email": "sophia.brown@zylker.com",
"contact_number": "+11345678903"
}
]
}Sample Response
Copied{
"response": {
"returnvalue": {
"response": [
{
"id": "150220000000558268",
"name": "Peter John",
"email": "peter.john@zylker.com",
"contact_number": "+11345678901",
"type": "Guest",
"status": "success"
},
{
"id": "150220000000558269",
"name": "William Jones",
"email": "william.jones@zylker.com",
"contact_number": "+11345678902",
"type": "Guest",
"status": "success"
},
{
"id": "150220000000558270",
"name": "Sophia Brown",
"email": "sophia.brown@zylker.com",
"contact_number": "+11345678903",
"type": "Guest",
"status": "success"
}
]
},
"status": "success"
}
}