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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zoho

Zoho Zoho CRM Related Records API API

The Zoho CRM Related Records API API from Zoho — 2 operation(s) for zoho crm related records api.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Zoho CRM Related Records API API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Zoho CRM Related Records API. 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 18 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

6 operations 2 paths 18 schemas 2 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 Zoho CRM Related Records API 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.

Zoho CRM Related Records API 6
GET
/{parentRecordModule}/{parentRecord}/{relatedList}
List Related Records
getRelatedRecords 12 params → 200204400401403404500
PUT
/{parentRecordModule}/{parentRecord}/{relatedList}
Update Related Records
updateRelatedRecords 3 params body → 200207400401403404500
DELETE
/{parentRecordModule}/{parentRecord}/{relatedList}
Remove Related Records by IDs
delinkRelatedRecords 4 params → 200207400401403404500
GET
/{parentRecordModule}/{parentRecord}/{relatedList}/{record}
Get Specific Related Record
getRelatedRecord 5 params → 200204400401403404500
PUT
/{parentRecordModule}/{parentRecord}/{relatedList}/{record}
Update Specific Related Record
updateSpecificRelatedRecord 4 params body → 200400401403404500
DELETE
/{parentRecordModule}/{parentRecord}/{relatedList}/{record}
Delink Specific Related Record
delinkSpecificRelatedRecord 4 params → 200400401403404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are InvalidModuleError (4 properties), InvalidUrlPatternError (4 properties), NoPermissionError (4 properties), MandatoryNotFoundError (4 properties). Each schema is shown below with its type and property counts.

MandatoryNotFoundError
object
Error response for missing required parameter.
4 properties 3 required
MandatoryNotFoundBulkError
object
Error response for mandatory field not found in bulk operations with data array wrapper.
1 property 1 required
InvalidUrlPatternError
object
Error response when the request URL pattern is incorrect.
4 properties 3 required
InvalidModuleError
object
Error response for invalid module name.
4 properties 3 required
AuthorizationFailedError
object
Error response for insufficient privilege.
4 properties 3 required
NotSupportedError
object
Error response for modules not supported in the API.
4 properties 3 required
LimitExceededError
object
Error response when the number of items exceeds the allowed limit.
4 properties 3 required
RecordNotFoundError
object
Error response for record not found.
4 properties 3 required
RequiredParamMissingError
object
Error response for missing required parameter.
4 properties 3 required
InvalidTokenError
object
Error response for invalid authentication token.
4 properties 3 required
InvalidRequestMethodError
object
Error response for invalid HTTP request method.
4 properties 3 required
InvalidDataError
object
Error response for INVALIDDATA (invalid IDs, invalid related list/relation name, hidden related list in layout, invalid input, etc.).
4 properties 4 required
BulkOperationResponse
object
Response structure for bulk operations (update, delete)
1 property 1 required
UnableToParseDataTypeError
object
Error response for wrong format in request body or parameters.
4 properties 3 required
InternalError
object
Error response for internal server error.
4 properties 3 required
RelationNotFoundBulkError
object
Error response for relation not found in bulk operations with data array wrapper.
1 property 1 required
OAuthScopeMismatchError
object
Error response when the access token does not have the required OAuth scope for this API call.
4 properties 3 required
NoPermissionError
object
Error response for permission denied.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-zoho-crm-related-records-api-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
AE Profile APIs.io
Zoho Books
AE Profile APIs.io
Zoho Invoice
AE Profile APIs.io
Zoho Billing
AE Profile APIs.io
Zoho Expense
AE Profile APIs.io
Zoho People
AE Profile APIs.io
Zoho Recruit
AE Profile APIs.io
Zoho Projects
AE Profile APIs.io
Zoho Mail
AE Profile APIs.io
Zoho Sign
AE Profile APIs.io
Zoho Campaigns
AE Profile APIs.io
Zoho SalesIQ
AE Profile APIs.io
#Zoho CRM Related Records API
← Back to Z APIs
API Details
ID
zoho:zoho-zoho-crm-related-records-api-api
Docs
https://www.zoho.com/inventory/api/v1/introduction/
Provider
Zoho
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network