API Docs
/
No Results Found
Contact Persons

Attribute

contact_id
string
Contact id of the contact
contact_person_id
string
The id of the contact person
salutation
string
Salutation for the contact. Max-length [25]
first_name
string
First name of the contact person. Max-length [100]
last_name
string
Last name of the contact person. Max-length [100]
email
string
Email address of the contact person. Max-length [100]
phone
string
Max-length [50]
mobile
string
Max-length [50]
is_primary_contact
boolean
To mark contact person as primary for contact
skype
string
skype address. Max-length [50]
designation
string
designation of a person. Max-length [50]
department
string
department on which a person belongs. Max-length [50]
is_added_in_portal
boolean
tells whether the contact person has portal access/not

Example

[ { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true } ]

Create a contact person

Create a contact person for contact.
oauthscope : ZohoBooks.contacts.CREATE

Arguments

contact_id
string
Contact id of the contact
salutation
string
Salutation for the contact. Max-length [25]
first_name
string
(Required)
First name of the contact person. Max-length [100]
last_name
string
Last name of the contact person. Max-length [100]
email
string
Email address of the contact person. Max-length [100]
phone
string
Max-length [50]
mobile
string
Max-length [50]
skype
string
skype address. Max-length [50]
designation
string
designation of a person. Max-length [50]
department
string
department on which a person belongs. Max-length [50]
enable_portal
boolean
option to enable the portal access. allowed values true,false

Request Example

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

Body Parameters

Click to copy
{ "contact_id": 460000000026049, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "enable_portal": true }

Response Example

{ "code": 0, "message": "The contactperson has been Created", "contact_person": [ { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true }, {...}, {...} ] }

Update a contact person

Update an existing contact person.
oauthscope : ZohoBooks.contacts.UPDATE

Arguments

contact_id
string
(Required)
Contact id of the contact
salutation
string
Salutation for the contact. Max-length [25]
first_name
string
(Required)
First name of the contact person. Max-length [100]
last_name
string
Last name of the contact person. Max-length [100]
email
string
Email address of the contact person. Max-length [100]
phone
string
Max-length [50]
mobile
string
Max-length [50]
skype
string
skype address. Max-length [50]
designation
string
designation of a person. Max-length [50]
department
string
department on which a person belongs. Max-length [50]
enable_portal
boolean
option to enable the portal access. allowed values true,false
is_primary_contact
boolean
To mark contact person as primary for contact

Request Example

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

Body Parameters

Click to copy
{ "contact_id": 460000000026049, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "enable_portal": true, "is_primary_contact": true }

Response Example

{ "code": 0, "message": "The contactperson details has been updated.", "contact_person": [ { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true }, {...}, {...} ] }

Delete a contact person

Delete an existing contact person.
oauthscope : ZohoBooks.contacts.DELETE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/contactpersons/{contact_person_id} -X DELETE

Response Example

{ "code": 0, "message": "The contact person has been deleted." }

List contact persons

List all contacts with pagination.
oauthscope : ZohoBooks.contacts.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/contactpersons

Response Example

{ "code": 0, "message": "success", "contact_persons": [ { "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "sort_column": "contact_person_id", "sort_order": "A" } }

Get a contact person

Get the contact person details.
oauthscope : ZohoBooks.contacts.READ

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/{contact_id}/contactpersons/{contact_person_id} -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "contact_person": { "contact_id": 460000000026049, "contact_person_id": 460000000026051, "salutation": "Mr", "first_name": "Will", "last_name": "Smith", "email": "willsmith@bowmanfurniture.com", "phone": "+1-925-921-9201", "mobile": "+1-4054439562", "is_primary_contact": true, "skype": "zoho", "designation": "Sales Engineer", "department": "Sales", "is_added_in_portal": true } }

Mark as primary contact person

Mark a contact person as primary for the contact.
oauthscope : ZohoBooks.contacts.CREATE

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/contacts/contactpersons/{contact_person_id}/primary -X POST

Response Example

{ "code": 0, "message": "This contact person has been marked as your primary contact person." }