Zoho Contact Roles API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Contact Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.
This API exposes
6 operations
across 2 paths,
and defines 9 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
6 operations2 paths9 schemas2 DELETE2 GET2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1
Authentication & Security 1
Zoho Contact Roles API declares
1 security scheme
for authenticating requests.
It defines a custom scheme (iam-oauth2-schema).
Paths & Operations 6
Across 2 paths, the API surfaces 6 operations — 2 DELETE, 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RequiredParamMissingError (4 properties), NoPermissionContactsError (4 properties), InvalidDataError (4 properties), InvalidRelationNameError (4 properties). Each schema is shown below with its type and property counts.
InvalidRelationNameError
object
Invalid relation name error
4 properties4 required
UpsertRelationsRequest
object
Payload for adding or updating contact role relations on a deal
1 property1 required
NoPermissionContactsError
object
No permission to view contacts
4 properties4 required
UpsertRelationsSuccessResponse
object
Response returned after adding or updating contact role relations
1 property1 required
RequiredParamMissingError
object
Required parameter missing error
4 properties4 required
DeleteRelationsSuccessResponse
object
Response returned after deleting contact role relations
1 property1 required
NoPermissionDealsError
object
No permission to view deals
4 properties4 required
InvalidModuleError
object
Invalid module name error
4 properties4 required
InvalidDataError
object
Invalid related ID error
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
