Contact Persons
A contact person is an individual who acts as a representative of an organisation for communication purpose. For example, a Manager can be a contact person for an organisation.
End Points
Create a contact person
Update a contact person
Delete a contact person
List contact persons
Get a contact person
Mark as primary contact person
Attribute
contact_id
string
ID of the contact person
contact_person_id
string
The ID of the contact person
salutation
string
Salutation for the contact.
Maximum length allowed [25] first_name
string
First Name of the contact.
Maximum length allowed [100] last_name
string
Last Name of the contact.
Maximum length allowed [100] email
string
Email ID of the contact person.
Maximum length allowed [100] phone
string
Phone number of the contact person.
Maximum length [50] mobile
string
Mobile/Cell number of the contact person.
Maximum length [50] is_primary_contact
boolean
To mark contact person as primary for communication.
skype
string
skype address of the contact person.
Maximum length [50] designation
string
designation of the contact person in the organisation.
Maximum length [50] department
string
department to which the contact person belongs.
Maximum length [50] is_added_in_portal
boolean
tells whether the contact person has portal access or not
[
{
"contact_id": 460000000026049,
"contact_person_id": 460000000026051,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"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 : ZohoInvoice.contacts.CREATE
Arguments
contact_id
string
ID of the contact person
salutation
string
Salutation for the contact.
Maximum length allowed [25] first_name
string
(Required)
First Name of the contact.
Maximum length allowed [100] last_name
string
Last Name of the contact.
Maximum length allowed [100] email
string
Email ID of the contact person.
Maximum length allowed [100] phone
string
Phone number of the contact person.
Maximum length [50] mobile
string
Mobile/Cell number of the contact person.
Maximum length [50] skype
string
skype address of the contact person.
Maximum length [50] designation
string
designation of the contact person in the organisation.
Maximum length [50] department
string
department to which the contact person belongs.
Maximum length [50] enable_portal
boolean
option to enable or disable portal access the contact person. allowed values
true,false$ curl https://invoice.zoho.com/api/v3/contacts/contactpersons
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"contact_id": 460000000026049,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"skype": "zoho",
"designation": "Sales Engineer",
"department": "Sales",
"enable_portal": true
}
{
"code": 0,
"message": "success",
"contact_person": [
{
"contact_id": 460000000026049,
"contact_person_id": 460000000026051,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"is_primary_contact": true,
"skype": "zoho",
"designation": "Sales Engineer",
"department": "Sales",
"is_added_in_portal": true
},
{...},
{...}
]
}
Update a contact person
Update details of an existing contact person. oauthscope : ZohoInvoice.contacts.UPDATE
Arguments
contact_id
string
(Required)
ID of the contact person
salutation
string
Salutation for the contact.
Maximum length allowed [25] first_name
string
(Required)
First Name of the contact.
Maximum length allowed [100] last_name
string
Last Name of the contact.
Maximum length allowed [100] email
string
Email ID of the contact person.
Maximum length allowed [100] phone
string
Phone number of the contact person.
Maximum length [50] mobile
string
Mobile/Cell number of the contact person.
Maximum length [50] skype
string
skype address of the contact person.
Maximum length [50] designation
string
designation of the contact person in the organisation.
Maximum length [50] department
string
department to which the contact person belongs.
Maximum length [50] enable_portal
boolean
option to enable or disable portal access the contact person. allowed values
true,false$ curl https://invoice.zoho.com/api/v3/contacts/contactpersons/{contact_person_id}
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"contact_id": 460000000026049,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"skype": "zoho",
"designation": "Sales Engineer",
"department": "Sales",
"enable_portal": true
}
{
"code": 0,
"message": "success",
"contact_person": [
{
"contact_id": 460000000026049,
"contact_person_id": 460000000026051,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"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 : ZohoInvoice.contacts.DELETE
$ curl https://invoice.zoho.com/api/v3/contacts/contactpersons/{contact_person_id}
-X DELETE
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The contact person has been deleted."
}
List contact persons
List all contacts with pagination. oauthscope : ZohoInvoice.contacts.READ
$ curl https://invoice.zoho.com/api/v3/contacts/{contact_id}/contactpersons
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"contact_persons": [
{
"contact_id": 460000000026049,
"contact_person_id": 460000000026051,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"is_primary_contact": true,
"skype": "zoho",
"designation": "Sales Engineer",
"department": "Sales",
"is_added_in_portal": true
},
{...},
{...}
]
}
Get a contact person
Get the details of a contact person. oauthscope : ZohoInvoice.contacts.READ
$ curl https://invoice.zoho.com/api/v3/contacts/{contact_id}/contactpersons/{contact_person_id}
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"contact_person": {
"contact_id": 460000000026049,
"contact_person_id": 460000000026051,
"salutation": "Mr",
"first_name": "Will",
"last_name": "Smith",
"email": "test@zylker.org",
"phone": 1234,
"mobile": 1234,
"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 contact. oauthscope : ZohoInvoice.contacts.CREATE
$ curl https://invoice.zoho.com/api/v3/contacts/contactpersons/{contact_person_id}/primary
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "This contact person has been marked as your primary contact person."
}