Add Client API
This API is used to add client.
Request URL:
https://people.zoho.com/people/api/timetracker/addclient?clientName=<clientName>¤cy=<currency>&billingMethod=<billingMethod>&emailId=<emailId>&firstName=<firstName>&lastName=<lastName>&phoneNo=<phoneNo>&mobileNo=<mobileNo>&faxNo=<faxNo>&streetAddr=<streetAddr>&city=<city>&state=<state>&pincode=<pincode>&country=<country>&industry=<industry>&compsize=<compsize>&description=<description>
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Scope:
ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ
Possible Operation Types:
ALL - Complete access to data
DELETE - Only to delete data
Request parameter:
Parameter | Values Allowed | Default Value | Description |
*clientName | <Client name> | <Mandatory> | Specify the client name |
*currency | <Currency code> | <Mandatory> | Specify the currency code (Example INR for India) |
billingMethod | hourly job rate | hourly user rate | hourly user rate - jobs | hourly user rate - projects | - | Specify the billing method |
emailId | <Email Id> | - | Specify the email Id |
firstName | <First name> | - | Specify the first name |
lastName | <Last name> | - | Specify the last name |
phoneNo | <Phone number> | - | Specify the phone number |
mobileNo | <Mobile number> | - | Specify the mobile number |
faxNo | <Fax number> | - | Specify the fax number |
streetAddr | <Street Address> | - | Specify the street address |
city | <City name> | - | Specify the city name |
state | <State name> | - | Specify the state name |
pincode | <Pin code> | - | Specify the pin code |
country | <Country name> | - | Specify the country name (Example INDIA for India) |
industry | <Industry name> | - | Specify the industry name |
compsize | <Company size> | 0 | Specify the company size |
description | <Description> | - | Specify the description |
Error Codes and Messages :
Error Code | Error Message |
7038 | Permission denied |
8000 | No <parameter_name> parameter specified |
8001 | Wrong value given for <parameter_name> parameter |
8001 | Client Name already exists |
Success Response Format
{
"response": {
"result": [
{
"clientId": <Client Id>
}
],
"message": "Client added successfully",
"uri": "/api/timetracker/addclient",
"status": 0
}
}
Error Response Format
{
"response": {
"message": Error in adding/modifying Clients,
"uri": "/api/timetracker/addclient",
"errors": [
{
"code": <Error Code>,
"message": <Error Message>
}
],
"status": 1
}
}
Threshold Limit: 20 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Sample Request
Copiedhttps://people.zoho.com/people/api/timetracker/addclient?clientName=Adamo Meyrick¤cy=USD&billingMethod=hourlyjobrate&emailId=ameyrickd@wix.com&firstName=Adamo&
lastName=Meyrick&phoneNo=656-630-9381&mobileNo=7708753134&faxNo=+1-212-9876543&streetAddr=50, Oakland Avenue&city=#206 A city&state=Florida&pincode=32104&country=UNITED STATES&industry=Voolia&compsize=230&description=Food Door Delivering Company
Copiedhttps://people.zoho.com/people/api/timetracker/addclient?authtoken=9f8d1b973c85dbec3a335ac976319f6d&clientName=Adamo Meyrick¤cy=USD&billingMethod=hourlyjobrate&emailId=ameyrickd@wix.com&firstName=Adamo&
lastName=Meyrick&phoneNo=656-630-9381&mobileNo=7708753134&faxNo=+1-212-9876543&streetAddr=50, Oakland Avenue&city=#206 A city&state=Florida&pincode=32104&country=UNITED STATES&industry=Voolia&compsize=230&description=Food Door Delivering Company
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Response
Copied{
"response": {
"result": [
{
"clientId": "469505000000271259"
}
],
"message": "Client added successfully",
"uri": "/api/timetracker/addclient",
"status": 0
}
}
Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/addclient">
<status>0</status>
<message>Client added successfully</message>
<result>
<clientId>469505000000271259</clientId>
</result>
</response>