Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Inventory contact-persons API

Contact-Persons Module

Zoho Inventory contact-persons API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include contact-persons. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 6 operations across 5 paths, and defines 26 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

6 operations 5 paths 26 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory contact-persons API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

contact-persons 6

Contact-Persons Module

POST
/contacts/contactpersons
Create a contact person
create_contact_person 1 param body → 201
PUT
/contacts/contactpersons/{contact_person_id}
Update a contact person
update_contact_person 2 params body → 200
DELETE
/contacts/contactpersons/{contact_person_id}
Delete a contact person
delete_contact_person 2 params → 200
GET
/contacts/{contact_id}/contactpersons
List contact persons
list_contact_persons 4 params → 200
GET
/contacts/{contact_id}/contactpersons/{contact_person_id}
Get a contact person
get_contact_person 3 params → 200
POST
/contacts/contactpersons/{contact_person_id}/primary
Mark as primary contact person
mark_contact_person_as_primary 2 params → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are contact_person-response (14 properties), create-a-contact-person-request (12 properties), update-a-contact-person-request (12 properties), update-a-contact-person-response (3 properties). Each schema is shown below with its type and property counts.

delete-a-contact-person-response
object
2 properties
first_name
string
First Name of the contact. Maximum length allowed [100]
update-a-contact-person-response
object
3 properties
phone
string
Phone number of the contact person. Maximum length [50]
list-contact-persons-response
object
3 properties
contact_id
string
ID of the contact person
is_primary_contact
boolean
To mark contact person as primary for communication.
mark-as-primary-contact-person-response
object
2 properties
is_added_in_portal
boolean
tells whether the contact person has portal access or not
designation
string
designation of the contact person in the organisation. Maximum length [50]
salutation
string
Salutation for the contact. Maximum length allowed [25]
is_sms_enabled
boolean
Used to check if SMS communication preference is enabled for the contact person.
email
string
Email ID of the contact person. Maximum length allowed [100]
department
string
department to which the contact person belongs. Maximum length [50]
communication_preference
object
Preferred modes of communication for the contact person.
2 properties
contact_person-response
object
14 properties
get-a-contact-person-response
object
3 properties
create-a-contact-person-response
object
3 properties
update-a-contact-person-request
object
12 properties 2 required
last_name
string
Last Name of the contact. Maximum length allowed [100]
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person.
mobile
string
Mobile/Cell number of the contact person. Maximum length [50]
skype
string
skype address of the contact person. Maximum length [50]
enable_portal
boolean
option to enable or disable portal access the contact person. allowed values true , false
contact_person_id
string
The ID of the contact person
create-a-contact-person-request
object
12 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-contact-persons-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
Zoho Inventory items API