API specification for Services API. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 7 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Services API",
"description": "API specification for Services API",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server for /crm",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"com",
"eu",
"in",
"cn",
"au",
"ca",
"jp"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"paths": {
"/Services__s": {
"get": {
"summary": "GET /services_s",
"description": "services records get",
"operationId": "getServicesS",
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetservicessResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1872678286"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.READ"
]
}
]
},
"put": {
"summary": "PUT /services_s",
"description": "update services api",
"operationId": "putServicesS",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryAffectedData"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutservicessRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutservicessResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing data",
"properties": {
"data": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
"description": "success response in data",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/DataError"
},
"description": "error response in data",
"minContains": 1
}
],
"description": "Array of success or failure data items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
{
"$ref": "#/components/schemas/DataError"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DataError"
},
{
"$ref": "#/components/schemas/ErrorResponseCore564845355"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1569170772"
},
{
"$ref": "#/components/schemas/ErrorResponseCore197782636"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1225158361"
},
{
"$ref": "#/components/schemas/ErrorResponseCore695778820"
},
{
"$ref": "#/components/schemas/ErrorResponseCore775669499"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1835963120"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1173663876"
},
{
"$ref": "#/components/schemas/ErrorResponseCore542688165"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1924753111"
},
{
"$ref": "#/components/schemas/ErrorResponseCore531684933"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335501272"
},
{
"$ref": "#/components/schemas/ErrorResponseCore964180820"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604071034"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1484615382"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore591812267"
},
{
"$ref": "#/components/schemas/ErrorResponseCore578559762"
},
{
"$ref": "#/components/schemas/DataError"
}
]
},
"maxItems": 25
}
},
"required": [
"data"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.UPDATE"
]
}
]
},
"post": {
"summary": "POST /services_s",
"description": "create services api",
"operationId": "postServicesS",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostservicessRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created - Resource created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostservicessResponse201"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing data",
"properties": {
"data": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
"description": "success response in data",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/ErrorResponseCore1168955151"
},
"description": "error response in data",
"minContains": 1
}
],
"description": "Array of success or failure data items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1168955151"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore48783029"
},
{
"$ref": "#/components/schemas/ErrorResponseCore564845355"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1569170772"
},
{
"$ref": "#/components/schemas/ErrorResponseCore197782636"
},
{
"$ref": "#/components/schemas/ErrorResponseCore815194988"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1915970813"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1225158361"
},
{
"$ref": "#/components/schemas/ErrorResponseCore661033389"
},
{
"$ref": "#/components/schemas/ErrorResponseCore695778820"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1805991557"
},
{
"$ref": "#/components/schemas/ErrorResponseCore541683400"
},
{
"$ref": "#/components/schemas/ErrorResponseCore775669499"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1835963120"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1173663876"
},
{
"$ref": "#/components/schemas/ErrorResponseCore542688165"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1924753111"
},
{
"$ref": "#/components/schemas/ErrorResponseCore531684933"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335501272"
},
{
"$ref": "#/components/schemas/ErrorResponseCore964180820"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2060249394"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604071034"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1484615382"
},
{
"$ref": "#/components/schemas/ErrorResponseCore416413920"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore591812267"
},
{
"$ref": "#/components/schemas/ErrorResponseCore578559762"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1759680246"
}
]
},
"maxItems": 25
}
},
"required": [
"data"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.CREATE"
]
}
]
},
"delete": {
"summary": "DELETE /services_s",
"description": "services records delete",
"operationId": "deleteServicesS",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIds"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteservicessResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing data",
"properties": {
"data": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
"description": "success response in data",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/ErrorResponseCore297287888"
},
"description": "error response in data",
"minContains": 1
}
],
"description": "Array of success or failure data items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
{
"$ref": "#/components/schemas/ErrorResponseCore297287888"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1202290576"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
},
{
"$ref": "#/components/schemas/ErrorResponseCore980155013"
},
{
"$ref": "#/components/schemas/DataError"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.DELETE"
]
}
]
}
},
"/Services__s/{id}": {
"get": {
"summary": "GET /services_s/{id}",
"description": "services record get by id",
"operationId": "getServiceById",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetservicessResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1872678286"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.READ"
]
}
]
},
"put": {
"summary": "PUT /services_s/{id}",
"description": "update services api",
"operationId": "putServiceById",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryAffectedData"
},
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutservicessRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutservicessResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/DataError"
},
{
"$ref": "#/components/schemas/ErrorResponseCore564845355"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1569170772"
},
{
"$ref": "#/components/schemas/ErrorResponseCore197782636"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1225158361"
},
{
"$ref": "#/components/schemas/ErrorResponseCore695778820"
},
{
"$ref": "#/components/schemas/ErrorResponseCore775669499"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1835963120"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1173663876"
},
{
"$ref": "#/components/schemas/ErrorResponseCore542688165"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1924753111"
},
{
"$ref": "#/components/schemas/ErrorResponseCore531684933"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335501272"
},
{
"$ref": "#/components/schemas/ErrorResponseCore964180820"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604071034"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1484615382"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore591812267"
},
{
"$ref": "#/components/schemas/ErrorResponseCore578559762"
}
]
},
"maxItems": 25
}
},
"required": [
"data"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.UPDATE"
]
}
]
},
"delete": {
"summary": "DELETE /services_s/{id}",
"description": "services record delete by id",
"operationId": "deleteServiceById",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathServiceId"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteservicessResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1202290576"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
},
{
"$ref": "#/components/schemas/ErrorResponseCore980155013"
},
{
"$ref": "#/components/schemas/DataError"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.services.DELETE"
]
}
]
}
}
},
"components": {
"schemas": {
"ErrorResponseCore964180820": {
"type": "object",
"additionalProperties": false,
"description": "Available Dates value in holiday or Not in BusinessDays",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"DEPENDENT_MISMATCH"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"dependee": {
"type": "object",
"additionalProperties": false,
"description": "Detail field: dependee",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"json_path"
]
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"dependee",
"json_path"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Available Dates value in holiday or Not in BusinessDays"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"DataNested1": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for data",
"properties": {
"code": {
"type": "string",
"description": "Field: code",
"maxLength": 255
},
"details": {
"$ref": "#/components/schemas/DetailsNested"
},
"message": {
"type": "string",
"description": "Field: message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "Field: status",
"maxLength": 255
}
}
},
"MembersBase": {
"type": "object",
"additionalProperties": true,
"description": "Base schema for Members",
"properties": {
"module": {
"type": [
"string",
"null"
],
"description": "member module",
"maxLength": 100
},
"name": {
"type": [
"string",
"null"
],
"description": "name of the owner",
"enum": [
"Madeshwaran G"
],
"maxLength": 100
},
"id": {
"type": [
"string",
"null"
],
"description": "id of the owner",
"enum": [
"4671651000000635001"
],
"maxLength": 100
}
}
},
"LayoutNested": {
"type": "object",
"additionalProperties": false,
"description": "Layout id",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "id",
"maxLength": 18
}
}
},
"ErrorResponseCore197782636": {
"type": "object",
"additionalProperties": false,
"description": "invalid data",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"expected_data_type": {
"type": "string",
"description": "Detail field: expected_data_type",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"expected_data_type",
"json_path"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"invalid data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1872678286": {
"type": "object",
"additionalProperties": false,
"description": "One of the expected parameter is missing",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"REQUIRED_PARAM_MISSING"
]
},
"details": {
"type": "object",
"additio
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-services-openapi.json