API for changing the owner of records in CRM modules. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 2 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Change Owner",
"description": "API for changing the owner of records in CRM modules",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.change_owner.CREATE"
]
}
],
"paths": {
"/{module}/{record}/actions/change_owner": {
"post": {
"summary": "Change owner for a single record",
"description": "Updates the owner of a specific record in the module",
"operationId": "singleUpdate",
"parameters": [
{
"$ref": "#/components/parameters/Module"
},
{
"$ref": "#/components/parameters/Record"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Request body for changing the owner of a record",
"additionalProperties": false,
"properties": {
"owner": {
"type": "object",
"description": "The new owner information",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The ID of the new owner",
"maxLength": 19
}
},
"required": [
"id"
]
},
"notify": {
"type": [
"boolean",
"null"
],
"description": "Whether to notify the new owner"
},
"related_modules": {
"type": "array",
"description": "Related modules to update",
"maxItems": 5,
"items": {
"type": "object",
"description": "Related module information",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "The API name of the related module",
"enum": [
"Tasks",
"Events",
"Calls",
"Contacts",
"Deals"
]
},
"id": {
"type": "string",
"description": "The ID of the related module record",
"maxLength": 19
}
}
}
}
},
"required": [
"owner"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success response with validation errors",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Successful owner change response",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Response code indicating success",
"enum": [
"SUCCESS"
]
},
"details": {
"type": "object",
"description": "Details of the updated record",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The ID of the updated record",
"maxLength": 19
}
},
"required": [
"id"
]
},
"message": {
"type": "string",
"description": "Success message",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the operation",
"enum": [
"success"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
}
]
}
}
}
},
"400": {
"description": "Bad Request - Invalid input parameters or unsupported module",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Error response for unsupported operations or invalid module",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"NOT_SUPPORTED",
"INVALID_DATA",
"INVALID_MODULE"
]
},
"details": {
"type": "object",
"description": "Additional details about the error",
"additionalProperties": false,
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Index of the resource path that caused the error"
}
},
"required": [
"resource_path_index"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "Error response for invalid data or mandatory field not found",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"INVALID_DATA",
"NOT_SUPPORTED",
"MANDATORY_NOT_FOUND"
]
},
"details": {
"type": "object",
"description": "Additional details about the error",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the field that caused the error",
"maxLength": 200
},
"json_path": {
"type": "string",
"description": "JSON path to the field that caused the error",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "Error response for missing expected fields",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"EXPECTED_FIELD_MISSING"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
},
"details": {
"type": "object",
"description": "Details about the missing expected fields",
"additionalProperties": false,
"properties": {
"expected_fields": {
"type": "array",
"description": "List of expected fields that are missing",
"maxItems": 100,
"items": {
"type": "object",
"description": "Information about an expected field",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the expected field",
"maxLength": 200
},
"json_path": {
"type": "string",
"description": "JSON path to the expected field",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
}
}
},
"required": [
"expected_fields"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
},
{
"type": "object",
"description": "Error response for ambiguous data during processing",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"AMBIGUITY_DURING_PROCESSING"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
},
"details": {
"type": "object",
"description": "Details about the ambiguity",
"additionalProperties": false,
"properties": {
"ambiguity_due_to": {
"type": "array",
"description": "List of fields causing ambiguity",
"maxItems": 100,
"items": {
"type": "object",
"description": "Information about a field causing ambiguity",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the field causing ambiguity",
"maxLength": 200
},
"json_path": {
"type": "string",
"description": "JSON path to the field causing ambiguity",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
}
}
},
"required": [
"ambiguity_due_to"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - User does not have permission to perform this operation",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Error response when user lacks required permissions",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating permission denial",
"enum": [
"NO_PERMISSION"
]
},
"message": {
"type": "string",
"description": "Error message describing the permission issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
},
"details": {
"type": "object",
"description": "Additional details about missing permissions",
"additionalProperties": false,
"properties": {
"permissions": {
"type": "array",
"description": "List of required permissions that are missing",
"maxItems": 1,
"items": {
"type": "string",
"description": "Permission name",
"maxLength": 200
}
}
},
"required": [
"permissions"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.change_owner.CREATE"
]
}
]
}
},
"/{module}/actions/change_owner": {
"post": {
"summary": "Change owner for multiple records",
"description": "Updates the owner of multiple records in the module",
"operationId": "bulkChangeOwner",
"parameters": [
{
"$ref": "#/components/parameters/Module"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Request body for changing the owner of multiple records",
"additionalProperties": false,
"properties": {
"ids": {
"type": "array",
"description": "Array of record IDs to change owner",
"maxItems": 500,
"items": {
"type": "string",
"description": "Record ID",
"maxLength": 19
}
},
"owner": {
"type": "object",
"description": "The new owner information",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The ID of the new owner",
"maxLength": 19
}
},
"required": [
"id"
]
},
"notify": {
"type": [
"boolean",
"null"
],
"description": "Whether to notify the new owner"
},
"related_modules": {
"type": "array",
"description": "Related modules to update",
"maxItems": 5,
"items": {
"type": "object",
"description": "Related module information",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "The API name of the related module",
"enum": [
"Tasks",
"Events",
"Calls",
"Contacts",
"Deals"
]
},
"id": {
"type": "string",
"description": "The ID of the related module record",
"maxLength": 19
}
}
}
}
},
"required": [
"ids",
"owner"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success response with validation errors",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Successful owner change response",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Response code indicating success",
"enum": [
"SUCCESS"
]
},
"details": {
"type": "object",
"description": "Details of the updated record",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The ID of the updated record",
"maxLength": 19
}
},
"required": [
"id"
]
},
"message": {
"type": "string",
"description": "Success message",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the operation",
"enum": [
"success"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
}
]
}
}
}
},
"400": {
"description": "Bad Request - Invalid input parameters or unsupported module",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Error response for unsupported operations or invalid module",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"NOT_SUPPORTED",
"INVALID_DATA",
"INVALID_MODULE"
]
},
"details": {
"type": "object",
"description": "Additional details about the error",
"additionalProperties": false,
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Index of the resource path that caused the error"
}
},
"required": [
"resource_path_index"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "Error response for invalid data or mandatory field not found",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"INVALID_DATA",
"NOT_SUPPORTED",
"MANDATORY_NOT_FOUND"
]
},
"details": {
"type": "object",
"description": "Additional details about the error",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the field that caused the error",
"maxLength": 200
},
"json_path": {
"type": "string",
"description": "JSON path to the field that caused the error",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"description": "Error response for missing expected fields",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code indicating the type of error",
"enum": [
"EXPECTED_FIELD_MISSING"
]
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"error"
]
},
"details": {
"type": "object",
"description": "Details about the missing expected fields",
"additionalProperties": false,
"properties": {
"expected_fields": {
"type": "array",
"description": "List of expected fields that are missing",
"maxItems": 100,
"items": {
"type": "object",
"description": "Information about an expected field",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the expected field",
"maxLength": 200
},
"json_path": {
"type": "string",
"description": "JSON path to the expected field",
"maxLength": 500
}
},
"required": [
"api_name",
"json_path"
]
}
}
},
"required": [
"expected_fields"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
},
{
"type": "object",
"description": "Error response for ambiguous data during processing",
"additionalProperties": false,
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-change-owner-openapi.json