openapi: 3.1.0 info: title: Helpcenter Actions API version: 1.0.0 tags: - name: Actions paths: /{module}/actions/mass_change_owner: post: summary: Mass change owner of records description: Mass change the owner of records in a module based on a custom view operationId: massChangeOwner parameters: - $ref: '#/components/parameters/Module' requestBody: content: application/json: schema: type: object description: Request body for mass changing owner of records additionalProperties: false properties: cvid: type: string description: Custom view ID maxLength: 19 owner: type: object description: New owner information additionalProperties: false properties: id: type: string description: Owner ID maxLength: 19 required: - id territory: type: object description: Territory information additionalProperties: false properties: id: type: string description: Territory ID maxLength: 19 include_child: type: - boolean - 'null' description: Whether to include child territories in the mass change operation required: - id criteria: oneOf: - description: Value-based criteria type: object additionalProperties: false properties: field: description: Field to filter on type: object additionalProperties: false properties: api_name: description: API name of the field type: string maxLength: 255 id: description: ID of the field type: string maxLength: 19 required: - api_name comparator: description: Comparison operator type: string enum: - equal - ends_with - not_equal - greater_than - less_than - not_between - starts_with - between - less_equal - greater_equal value: description: Value to compare against type: string maxLength: 255 required: - field - comparator - value required: - cvid - owner required: true responses: '202': description: Mass change owner request accepted and scheduled successfully content: application/json: schema: type: object description: Response containing the scheduled job details additionalProperties: false properties: data: type: array description: Array of response data maxItems: 1 items: type: object description: Job scheduling details additionalProperties: false properties: status: type: string description: Status of the operation enum: - success code: type: string description: Response code enum: - SCHEDULED message: type: string description: Response message enum: - change owner is successfully scheduled details: type: object description: Additional details about the scheduled job additionalProperties: false properties: job_id: type: string description: Unique identifier for the scheduled job maxLength: 19 required: - job_id required: - status - code - message - details required: - data '400': description: Bad Request - Invalid input parameters or data content: application/json: schema: oneOf: - type: object description: Error response for missing mandatory fields (cvid or owner id) additionalProperties: false properties: code: type: string description: Error code indicating mandatory field is missing enum: - MANDATORY_NOT_FOUND message: type: string description: Error message describing the missing field maxLength: 255 status: type: string description: Status of the response enum: - error details: type: object description: Additional details about the missing field additionalProperties: false properties: api_name: type: string description: API name of the missing field maxLength: 255 json_path: type: string description: JSON path to the missing field maxLength: 255 required: - api_name - json_path required: - code - message - status - details - type: object description: Error response for invalid data or module additionalProperties: false properties: code: type: string description: Error code indicating invalid data or module enum: - INVALID_DATA - NOT_SUPPORTED message: type: string description: Error message describing the invalid data or module maxLength: 255 details: oneOf: - type: object description: Details about the invalid field additionalProperties: false properties: api_name: type: string description: API name of the invalid field maxLength: 255 json_path: type: string description: JSON path to the invalid field maxLength: 255 anyOf: - type: object description: Requires api_name additionalProperties: false required: - api_name - type: object description: Requires json_path additionalProperties: false required: - json_path - type: object description: Details about invalid resource path additionalProperties: false properties: resource_path_index: type: integer description: Index of the invalid resource path format: int32 required: - resource_path_index - type: object description: When the given owner id is not valid (not_crm_user/deleted/inactive) additionalProperties: false properties: owner_status: type: string description: Status of the owner enum: - not_crm_user - deleted - inactive api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 255 required: - owner_status - api_name - json_path - type: object description: Details about expected data type mismatch additionalProperties: false properties: expected_data_type: type: string description: Expected data type of the field maxLength: 255 api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 255 required: - expected_data_type - api_name - json_path status: type: string description: Status of the response enum: - error required: - code - message - details - status - type: object description: Error response when record limit is exceeded additionalProperties: false properties: status: type: string description: Status of the response enum: - error code: type: string description: Error code indicating record limit exceeded enum: - RECORD_LIMIT_EXCEEDED message: type: string description: Error message describing the limit exceeded maxLength: 255 details: type: object description: Additional details about the exceeded limit additionalProperties: false properties: limit: type: string description: The record limit that was exceeded maxLength: 255 required: - limit required: - status - code - message - details - type: object description: Error response when expected fields are missing in criteria additionalProperties: false properties: code: type: string description: Error code indicating expected field is missing enum: - EXPECTED_FIELD_MISSING message: type: string description: Error message describing the missing field maxLength: 255 status: type: string description: Status of the response enum: - error details: type: object description: Additional details about the missing field additionalProperties: false properties: expected_fields: type: array description: List of missing expected fields maxItems: 2 items: type: object description: Details of a missing expected field additionalProperties: false properties: api_name: type: string description: API name of the missing field maxLength: 255 json_path: type: string description: JSON path to the missing field maxLength: 255 required: - expected_fields required: - code - message - status - details - type: object description: Error response when ambiguous fields are provided additionalProperties: false properties: code: type: string description: Error code indicating ambiguity in field specification enum: - AMBIGUITY_DURING_PROCESSING message: type: string description: Error message describing the missing field maxLength: 255 status: type: string description: Status of the response enum: - error details: type: object description: Additional details about the ambiguous fields additionalProperties: false properties: ambiguity_due_to: type: array description: List of fields causing ambiguity maxItems: 2 items: type: object description: Details of an ambiguous field additionalProperties: false properties: api_name: type: string description: API name of the ambiguous field maxLength: 255 json_path: type: string description: JSON path to the ambiguous field maxLength: 255 required: - ambiguity_due_to required: - code - message - status - details - type: object description: Error response for missing dependent fields additionalProperties: false properties: code: type: string description: Error code indicating dependent field is missing or mismatched enum: - DEPENDENT_FIELD_MISSING - DEPENDENT_MISMATCH message: type: string description: Error message describing the missing field maxLength: 255 status: type: string description: Status of the response enum: - error details: type: object description: Additional details about the missing field additionalProperties: false properties: dependee: type: object description: Details about the dependee field additionalProperties: false properties: api_name: type: string description: API name of the dependee field maxLength: 255 json_path: type: string description: JSON path to the dependee field maxLength: 255 required: - api_name - json_path api_name: type: string description: API name of the missing field maxLength: 255 json_path: type: string description: JSON path to the missing field maxLength: 255 required: - api_name - json_path - dependee required: - code - message - status - details security: - iam-oauth2-schema: - ZohoCRM.change_owner.CREATE tags: - Actions get: summary: Check mass change owner job status description: Check the status of a mass change owner job using the job ID operationId: checkStatus parameters: - name: module in: path description: The API name of the module required: true schema: type: string maxLength: 255 - $ref: '#/components/parameters/JobId' responses: '200': description: Successfully retrieved mass change owner job status content: application/json: schema: type: object description: Response containing the job status details additionalProperties: false properties: data: type: array description: Array of job status data maxItems: 1 items: type: object description: Job status details additionalProperties: false properties: Status: type: string description: Current status of the job enum: - COMPLETED Failed_Count: type: integer description: Number of records that failed to update format: int32 Not_Updated_Count: type: integer description: Number of records that were not updated format: int32 Updated_Count: type: integer description: Number of records successfully updated format: int32 Total_Count: type: integer description: Total number of records processed format: int32 required: - Status - Failed_Count - Not_Updated_Count - Updated_Count - Total_Count required: - data '204': description: Job details not found '400': description: Bad Request - Invalid input parameters or data content: application/json: schema: oneOf: - type: object description: Error response for missing required query parameter additionalProperties: false properties: code: type: string description: Error code indicating required parameter is missing enum: - REQUIRED_PARAM_MISSING message: type: string description: Error message describing the missing field maxLength: 255 status: type: string description: Status of the response enum: - error details: type: object description: Additional details about the missing field additionalProperties: false properties: param_name: type: string description: Name of the missing parameter maxLength: 255 required: - param_name required: - code - message - status - details security: - iam-oauth2-schema: - ZohoCRM.change_owner.READ tags: - Actions /{moduleName}/{id}/actions/send_mail: post: operationId: sendMail summary: Send an email to a record description: Sends an email using specific templates or custom content to a record in a given module. security: - iam-oauth2-schema: - ZohoCRM.send_mail.all.CREATE parameters: - $ref: '#/components/parameters/ModuleName' - $ref: '#/components/parameters/Id' requestBody: description: Email details including sender, recipients, and content. required: true content: application/json: schema: $ref: '#/components/schemas/SendMailRequest' responses: '200': description: Mail sent successfully content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '400': description: Bad Request - Validation or Logic Error content: application/json: schema: oneOf: - $ref: '#/components/schemas/StandardErrorResponse' - $ref: '#/components/schemas/FlatErrorResponse' '403': description: Forbidden - Permission or Confirmation Required content: application/json: schema: $ref: '#/components/schemas/FlatErrorResponse' tags: - Actions /{moduleApiName}/{recordId}/actions/get_related_records_count: post: summary: Get Related Records Count description: Retrieves the count of related records for a specific parent record. Supports filtering by various criteria including approval status, conversion status, and custom field filters. This operation is useful for analytics and UI display purposes where you need to show counts without fetching the actual related records. operationId: getRelatedRecordsCount parameters: - $ref: '#/components/parameters/ModuleApiName' - $ref: '#/components/parameters/RecordId' requestBody: description: Request payload containing an array of related list specifications. Each item specifies a related list to count and optional filtering parameters to apply before counting. Supports filtering by field values, approval status, conversion status, and record categories. content: application/json: schema: $ref: '#/components/schemas/GetRelatedRecordsCountRequest' required: true responses: '200': description: Successfully retrieved the count of related records. Returns an array containing count information for each requested related list, along with the related list identifiers. content: application/json: schema: $ref: '#/components/schemas/GetRelatedRecordsCountResponse' '400': description: Bad Request. The request contains invalid data, such as missing required fields, invalid field values, unsupported operations, or malformed request structure. Error details will specify the exact validation failure. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.modules.READ tags: - Actions /{module}/{recordID}/actions/clone: post: operationId: cloneRecord summary: To clone a record in a module description: To clone a record in a module. parameters: - $ref: '#/components/parameters/Module_2' - $ref: '#/components/parameters/Record' requestBody: content: application/json: schema: description: By default, when you clone a record, the field values of the parent record will also be copied to the cloned record. If you want to modify certain fields or to add value to some fields, specify their field API names and their corresponding values in the input body. $ref: '#/components/schemas/RecordsInputSchema' responses: '201': description: Record is created successfully content: application/json: schema: $ref: '#/components/schemas/RecordSuccessResponse' '400': description: Bad Request - The request could not be processed due to invalid input, missing mandatory parameters content: application/json: schema: $ref: '#/components/schemas/RecordsErrorResponse' '401': description: Unauthorized - Authentication failed or insufficient OAuth scope permissions." content: application/json: schema: $ref: '#/components/schemas/RecordUnathorizedResponse' '403': description: Forbidden - User lacks permission to add records in the requested module, Records or This API is supported only for admin users. content: application/json: schema: $ref: '#/components/schemas/RecordPermissionResponse' '404': description: Not Found - The requested URL pattern is invalid or the specified resource does not exist. content: application/json: schema: $ref: '#/components/schemas/RecordInvalidURLResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/RecordInternalErrorResponse' security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Events.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Products.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Activities.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.CREATE - iam-oauth2-schema: - ZohoCRM.modules.custom.CREATE - iam-oauth2-schema: - ZohoCRM.modules.CREATE tags: - Actions /{moduleApiName}/{id}/actions/share_emails: post: description: To share emails of specific record with other users in your organization summary: Share Emails of a record operationId: shareEmails parameters: - name: moduleApiName in: path required: true description: Module Api Name of the record schema: type: string enum: - Leads - Contacts - Accounts - Deals - CustomModule1 - $ref: '#/components/parameters/Id_2' security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Events.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Products.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Activities.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.CREATE - iam-oauth2-schema: - ZohoCRM.modules.custom.CREATE - iam-oauth2-schema: - ZohoCRM.modules.CREATE responses: '200': description: Emails shared successfully content: application/json: schema: type: object description: Response schema for successful email sharing. additionalProperties: false properties: data: type: array description: List of results for the sharing operation. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - SUCCESS details: type: object description: Details of the shared record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Successfully shared status: type: string description: The status of the operation. enum: - success required: - code - details - message - status '400': description: Failure in email sharing content: application/json: schema: oneOf: - type: object description: Invalid data provided. additionalProperties: false properties: code: type: string description: Error code for invalid data. enum: - INVALID_DATA details: type: object description: Details about the invalid data. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for invalid data. enum: - the related id given seems to be invalid status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Invalid module provided. additionalProperties: false properties: code: type: string description: Error code for invalid module. enum: - INVALID_MODULE details: type: object description: Details about the invalid module. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for invalid module. enum: - the module name given seems to be invalid status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Module not supported. additionalProperties: false properties: code: type: string description: Error code for unsupported module. enum: - NOT_SUPPORTED details: type: object description: Details about the unsupported module. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for unsupported module. enum: - the given module is not supported in api status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Custom sharing not enabled. additionalProperties: false properties: code: type: string description: Error code for custom sharing not enabled. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false message: type: string description: Error message for custom sharing not enabled. enum: - User did not enable custom sharing status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Email configuration does not exist. additionalProperties: false properties: code: type: string description: Error code for missing email configuration. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false message: type: string description: Error message for missing email configuration. enum: - Email Configuration does not exist status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Emails already shared. additionalProperties: false properties: data: type: array description: List of results indicating already shared status. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - ALREADY_SHARED details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Emails are already shared to the colleagues already status: type: string description: The status of the operation. enum: - error required: - code - details - message - status - type: object description: Invalid data type. additionalProperties: false properties: code: type: string description: Error code for invalid data type. enum: - INVALID_DATA details: type: object description: Details about the invalid data type. additionalProperties: false properties: expected_data_type: type: string description: The expected data type. format: string api_name: type: string description: The API name of the field with the wrong data type. format: string required: - expected_data_type - api_name message: type: string description: Error message for invalid data type. format: string status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Operation not allowed. additionalProperties: false properties: code: type: string description: Error code for not allowed operation. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for not allowed operation. format: string status: type: string description: Status of the error. enum: - error required: - code - details - message - status '403': description: Permission denied content: application/json: schema: type: object description: Permission denied error response. additionalProperties: false properties: code: type: string description: Error code for permission denied. enum: - NO_PERMISSION details: type: object description: Details about the missing permissions. additionalProperties: false properties: permissions: type: array description: List of required permissions. maxItems: 10 items: type: string description: A required permission. format: string message: type: string description: Error message for permission denied. enum: - permission denied status: type: string description: Status of the error. enum: - error required: - code - details - message - status tags: - Actions /{moduleApiName}/{id}/actions/unshare_emails: post: description: To unshare emails of specific record with other users in your organization summary: Unshare Emails of a record operationId: unshareEmails parameters: - name: moduleApiName in: path required: true description: Module Api Name of the record schema: type: string enum: - Leads - Contacts - Accounts - Deals - CustomModule1 - $ref: '#/components/parameters/Id_2' security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Deals.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Events.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Calls.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Products.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Cases.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Activities.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.DELETE - iam-oauth2-schema: - ZohoCRM.modules.custom.DELETE - iam-oauth2-schema: - ZohoCRM.modules.DELETE responses: '200': description: Emails sharing revoked successfully content: application/json: schema: type: object description: Response schema for successful email unsharing. additionalProperties: false properties: data: type: array description: List of results for the unsharing operation. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - SUCCESS details: type: object description: Details of the unshared record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Sharing revoked successfully status: type: string description: The status of the operation. enum: - success required: - code - details - message - status '400': description: Failure in revoking content: application/json: schema: oneOf: - type: object description: Invalid data provided. additionalProperties: false properties: code: type: string description: Error code for invalid data. enum: - INVALID_DATA details: type: object description: Details about the invalid data. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for invalid data. enum: - the related id given seems to be invalid status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Invalid module provided. additionalProperties: false properties: code: type: string description: Error code for invalid module. enum: - INVALID_MODULE details: type: object description: Details about the invalid module. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for invalid module. enum: - the module name given seems to be invalid status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Module not supported. additionalProperties: false properties: code: type: string description: Error code for unsupported module. enum: - NOT_SUPPORTED details: type: object description: Details about the unsupported module. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: Error message for unsupported module. enum: - the given module is not supported in api status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Custom sharing not enabled. additionalProperties: false properties: code: type: string description: Error code for custom sharing not enabled. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false message: type: string description: Error message for custom sharing not enabled. enum: - User did not enable custom sharing status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Email configuration does not exist. additionalProperties: false properties: code: type: string description: Error code for missing email configuration. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false message: type: string description: Error message for missing email configuration. enum: - Email Configuration does not exist status: type: string description: Status of the error. enum: - error required: - code - details - message - status '403': description: Permission denied content: application/json: schema: type: object description: Permission denied error response. additionalProperties: false properties: code: type: string description: Error code for permission denied. enum: - NO_PERMISSION details: type: object description: Details about the missing permissions. additionalProperties: false properties: permissions: type: array description: List of required permissions. maxItems: 10 items: type: string description: A required permission. format: string message: type: string description: Error message for permission denied. enum: - permission denied status: type: string description: Status of the error. enum: - error required: - code - details - message - status tags: - Actions /{moduleApiName}/actions/share_emails: post: description: To share emails of multiple records with other users in your organization summary: Share Emails in Bulk operationId: shareBulkEmails parameters: - name: moduleApiName in: path required: true description: Module Api Name of the record schema: type: string enum: - Leads - Contacts - Accounts - Deals - CustomModule1 security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Events.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Products.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Activities.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.CREATE - iam-oauth2-schema: - ZohoCRM.modules.custom.CREATE - iam-oauth2-schema: - ZohoCRM.modules.CREATE requestBody: description: The request sent with list of ids content: application/json: schema: type: object description: Request body for sharing emails in bulk. additionalProperties: false properties: ids: type: array description: A list of record IDs to share emails for. maxItems: 100 items: type: string description: The ID of a record. format: string required: - ids required: true responses: '200': description: Emails shared successfully content: application/json: schema: type: object description: Response schema for successful bulk email sharing. additionalProperties: false properties: data: type: array description: List of results for the bulk sharing operation. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - SUCCESS details: type: object description: Details of the shared record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Successfully shared status: type: string description: The status of the operation. enum: - success required: - code - details - message - status '207': description: Partial success in sharing emails. content: application/json: schema: type: object description: Response for partial success in bulk email sharing. additionalProperties: false properties: data: type: array description: List of results for the bulk sharing operation. maxItems: 100 items: oneOf: - type: object additionalProperties: false description: Emails already shared. properties: code: type: string description: Status code of the operation. enum: - ALREADY_SHARED details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Emails are already shared to the colleagues already status: type: string description: The status of the operation. enum: - error required: - code - details - message - status - type: object description: SuccessfulResult for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - SUCCESS details: type: object description: Details of the shared record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Successfully shared status: type: string description: The status of the operation. enum: - success required: - code - details - message - status - type: object description: Invalid data provided. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - INVALID_DATA details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - the related id given seems to be invalid status: type: string description: The status of the operation. enum: - error required: - code - details - message - status - type: object description: Operation not allowed Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: A message indicating the result. format: string status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Duplicate data provided Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - DUPLICATE_DATA details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Duplicate Data status: type: string description: The status of the operation. enum: - error required: - code - details - message - status '400': description: Failure in email sharing content: application/json: schema: oneOf: - type: object description: Invalid data provided. additionalProperties: false properties: data: type: array description: List of results indicating invalid data. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - INVALID_DATA details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: [] message: type: string description: A message indicating the result. enum: - the related id given seems to be invalid status: type: string description: The status of the operation. enum: - error required: - code - details - message - status - type: object description: Operation not allowed. additionalProperties: false properties: data: type: array description: List of results indicating not allowed operation. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: A message indicating the result. format: string status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Duplicate data provided. additionalProperties: false properties: data: type: array description: List of results indicating duplicate data. maxItems: 100 items: type: object description: Result for a single record. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - DUPLICATE_DATA details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Duplicate Data status: type: string description: The status of the operation. enum: - error required: - code - details - message - status '403': description: Permission denied content: application/json: schema: type: object description: Permission denied error response. additionalProperties: false properties: code: type: string description: Error code for permission denied. enum: - NO_PERMISSION details: type: object description: Details about the missing permissions. additionalProperties: false properties: permissions: type: array description: List of required permissions. maxItems: 10 items: type: string description: A required permission. format: string message: type: string description: Error message for permission denied. enum: - permission denied status: type: string description: Status of the error. enum: - error required: - code - details - message - status tags: - Actions /{moduleApiName}/actions/unshare_emails: post: description: To unshare emails of multiple records with other users in your organization summary: Unshare Emails in Bulk operationId: unshareBulkEmails parameters: - name: moduleApiName in: path required: true description: Module Api Name of the record schema: type: string enum: - Leads - Contacts - Accounts - Deals - CustomModule1 security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Deals.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Events.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Calls.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Products.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Cases.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Activities.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.DELETE - iam-oauth2-schema: - ZohoCRM.modules.custom.DELETE - iam-oauth2-schema: - ZohoCRM.modules.DELETE requestBody: description: The request sent with list of ids content: application/json: schema: type: object description: Request body for unsharing emails in bulk. additionalProperties: false properties: ids: type: array description: A list of record IDs to unshare emails for. maxItems: 100 items: type: string description: The ID of a record. format: string required: - ids required: true responses: '207': description: Partial success in revoking email sharing. content: application/json: schema: type: object description: Response for partial success in bulk email unsharing. additionalProperties: false properties: data: type: array description: List of results for the bulk unsharing operation. maxItems: 100 items: oneOf: - type: object description: Emails not shared. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - NOT_SHARED details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Emails are not shared to the colleagues already status: type: string description: The status of the operation. enum: - error required: - code - details - message - status - type: object description: Successful revocation. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - SUCCESS details: type: object description: Details of the unshared record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Sharing revoked successfully status: type: string description: The status of the operation. enum: - success required: - code - details - message - status - type: object description: Invalid data provided additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - INVALID_DATA details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - the related id given seems to be invalid status: type: string description: The status of the operation. enum: - error required: - code - details - message - status - type: object description: Operation not allowed. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - NOT_ALLOWED details: type: object description: Details about the error. additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path with an error. format: int32 required: - resource_path_index message: type: string description: A message indicating the result. format: string status: type: string description: Status of the error. enum: - error required: - code - details - message - status - type: object description: Duplicate data provided. additionalProperties: false properties: code: type: string description: Status code of the operation. enum: - DUPLICATE_DATA details: type: object description: Details of the record. additionalProperties: false properties: id: type: string description: The ID of the record. format: string required: - id message: type: string description: A message indicating the result. enum: - Duplicate Data status: type: string description: The status of the operation. enum: - error required: - code - details - message - status '403': description: Permission denied content: application/json: schema: type: object description: Permission denied error response. additionalProperties: false properties: code: type: string description: Error code for permission denied. enum: - NO_PERMISSION details: type: object description: Details about the missing permissions. additionalProperties: false properties: permissions: type: array description: List of required permissions. maxItems: 10 items: type: string description: A required permission. format: string message: type: string description: Error message for permission denied. enum: - permission denied status: type: string description: Status of the error. enum: - error required: - code - details - message - status tags: - Actions /{moduleApiName}/{recordId}/actions/share: get: operationId: getShareRecords summary: Get Share Records description: Get Share Records. API exposed to customers security: - iam-oauth2-schema: - ZohoCRM.share.leads.READ - iam-oauth2-schema: - ZohoCRM.share.contacts.READ - iam-oauth2-schema: - ZohoCRM.share.accounts.READ - iam-oauth2-schema: - ZohoCRM.share.deals.READ - iam-oauth2-schema: - ZohoCRM.share.products.READ - iam-oauth2-schema: - ZohoCRM.share.tasks.READ - iam-oauth2-schema: - ZohoCRM.share.events.READ - iam-oauth2-schema: - ZohoCRM.share.calls.READ - iam-oauth2-schema: - ZohoCRM.share.quotes.READ - iam-oauth2-schema: - ZohoCRM.share.invoices.READ - iam-oauth2-schema: - ZohoCRM.share.campaigns.READ - iam-oauth2-schema: - ZohoCRM.share.vendors.READ - iam-oauth2-schema: - ZohoCRM.share.pricebooks.READ - iam-oauth2-schema: - ZohoCRM.share.salesorders.READ - iam-oauth2-schema: - ZohoCRM.share.purchaseorders.READ - iam-oauth2-schema: - ZohoCRM.share.solutions.READ - iam-oauth2-schema: - ZohoCRM.share.cases.READ - iam-oauth2-schema: - ZohoCRM.share.cross_sellings.READ - iam-oauth2-schema: - ZohoCRM.share.next_buys.READ - iam-oauth2-schema: - ZohoCRM.share.first_buys.READ - iam-oauth2-schema: - ZohoCRM.share.rebuys.READ - iam-oauth2-schema: - ZohoCRM.share.bundles.READ - iam-oauth2-schema: - ZohoCRM.share.custom.READ parameters: - $ref: '#/components/parameters/ModuleApiName_2' - $ref: '#/components/parameters/RecordId_2' - $ref: '#/components/parameters/SharedTo' - $ref: '#/components/parameters/View' responses: '200': description: Success Response content: application/json: schema: description: Get Share Records Success Response type: object properties: share: type: array description: list of share records maxItems: 2147483647 items: type: object description: share record details properties: shared_with: type: object description: details of whom the record is shared with properties: name: type: string description: name of the entity with whom the record is shared maxLength: 100 id: type: string description: id of the entity with whom the record is shared maxLength: 20 type: type: string description: type of entity with whom the record is shared enum: - users - roles - groups additionalProperties: false required: - name - id - type share_related_records: type: boolean description: indicates if related records are shared shared_through: type: object description: details of the record through which sharing is done properties: module: type: object description: module details properties: name: type: string description: module name maxLength: 100 id: type: string description: module id maxLength: 20 additionalProperties: false required: - name - id id: type: string description: id of the record through which sharing is done maxLength: 20 additionalProperties: false required: - module - id shared_time: type: string description: time when the record was shared format: date-time permission: type: string description: level of access granted enum: - read_only - read_write - full_access shared_by: type: object description: details of the user who shared the record properties: name: type: string description: name of the user who shared the record maxLength: 100 id: type: string description: id of the user who shared the record maxLength: 20 zuid: type: string description: zuid of the user who shared the record maxLength: 20 additionalProperties: false required: - name - id - zuid type: type: string description: type of sharing enum: - private - public additionalProperties: false required: - shared_with - share_related_records - shared_through - permission - type additionalProperties: false '204': description: No Content '400': description: Bad Request Response content: application/json: schema: description: bad request response type: object additionalProperties: true oneOf: - $ref: '#/components/schemas/ViewParamWithManageValueErrorResponse' - $ref: '#/components/schemas/InvalidRecordIdErrorResponse' - $ref: '#/components/schemas/InvalidModuleNameErrorResponse' '403': description: Forbidden Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/CommonForbiddenErrorResponse' - $ref: '#/components/schemas/RecordForbiddenErrorResponse' tags: - Actions post: operationId: createShareRecords summary: Create Share Records description: Create Share Records. API exposed to customers security: - iam-oauth2-schema: - ZohoCRM.share.leads.CREATE - iam-oauth2-schema: - ZohoCRM.share.contacts.CREATE - iam-oauth2-schema: - ZohoCRM.share.accounts.CREATE - iam-oauth2-schema: - ZohoCRM.share.deals.CREATE - iam-oauth2-schema: - ZohoCRM.share.products.CREATE - iam-oauth2-schema: - ZohoCRM.share.tasks.CREATE - iam-oauth2-schema: - ZohoCRM.share.events.CREATE - iam-oauth2-schema: - ZohoCRM.share.calls.CREATE - iam-oauth2-schema: - ZohoCRM.share.quotes.CREATE - iam-oauth2-schema: - ZohoCRM.share.invoices.CREATE - iam-oauth2-schema: - ZohoCRM.share.campaigns.CREATE - iam-oauth2-schema: - ZohoCRM.share.vendors.CREATE - iam-oauth2-schema: - ZohoCRM.share.pricebooks.CREATE - iam-oauth2-schema: - ZohoCRM.share.salesorders.CREATE - iam-oauth2-schema: - ZohoCRM.share.purchaseorders.CREATE - iam-oauth2-schema: - ZohoCRM.share.solutions.CREATE - iam-oauth2-schema: - ZohoCRM.share.cases.CREATE - iam-oauth2-schema: - ZohoCRM.share.cross_sellings.CREATE - iam-oauth2-schema: - ZohoCRM.share.next_buys.CREATE - iam-oauth2-schema: - ZohoCRM.share.first_buys.CREATE - iam-oauth2-schema: - ZohoCRM.share.rebuys.CREATE - iam-oauth2-schema: - ZohoCRM.share.bundles.CREATE - iam-oauth2-schema: - ZohoCRM.share.custom.CREATE parameters: - $ref: '#/components/parameters/ModuleApiName_2' - $ref: '#/components/parameters/RecordId_2' requestBody: content: application/json: schema: type: object description: Create Share Records Request properties: share: type: array description: additional information maxItems: 20 items: type: object description: share record details properties: type: type: string description: type of sharing enum: - private - public share_related_records: type: boolean description: indicates if related records are shared permission: type: string description: level of access granted enum: - read_only - read_write - full_access shared_with: type: object description: details of whom the record is shared with properties: type: type: string description: type of entity with whom the record is shared enum: - roles - groups - users id: type: string description: id of the entity with whom the record is shared maxLength: 20 additionalProperties: false required: - type - id additionalProperties: false required: - type - permission - shared_with notify_shared_members: type: boolean description: indicates whether to notify the shared members notify_on_completion: type: boolean description: indicates whether to notify on completion additionalProperties: false required: - share required: true responses: '201': description: Create Share Records Success Response content: application/json: schema: description: Create Share Records Success Response type: object properties: share: type: array description: list of share record creation responses maxItems: 20 items: type: object description: share record creation response details properties: code: type: string description: response code enum: - SUCCESS details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - record will be shared successfully status: type: string description: response status enum: - success additionalProperties: false required: - code - details - message - status additionalProperties: false '400': description: Bad Request Response content: application/json: schema: description: bad request response type: object oneOf: - $ref: '#/components/schemas/InvalidShareWithValueErrorResponse' - $ref: '#/components/schemas/InvalidShareWithIdErrorResponse' - $ref: '#/components/schemas/ActivityModuleRelatedIssueErrorResponse' - $ref: '#/components/schemas/ShareLimitExceedErrorResponse' - $ref: '#/components/schemas/AmbiguousShareErrorResponse' - $ref: '#/components/schemas/MandatoryNotFound' - $ref: '#/components/schemas/InvalidTypeErrorResponse' - $ref: '#/components/schemas/MaximumLengthErrorResponse' - $ref: '#/components/schemas/InvalidRecordIdErrorResponse' - $ref: '#/components/schemas/UnsupportedModule' - $ref: '#/components/schemas/InvalidModuleNameErrorResponse' additionalProperties: true '403': description: Forbidden Response content: application/json: schema: type: object description: forbidden response oneOf: - $ref: '#/components/schemas/CommonForbiddenErrorResponse' - $ref: '#/components/schemas/SchedularAlreadyRunningErrorResponse' - $ref: '#/components/schemas/SharingSharedRecordErrorResponse' - $ref: '#/components/schemas/RecordLevelSharingNotSupportedForModuleErrorResponse' - $ref: '#/components/schemas/NotifyMembersWithoutFeeds' - $ref: '#/components/schemas/RecordForbiddenErrorResponse' additionalProperties: true tags: - Actions put: operationId: updateShareRecords summary: Update Share Records description: Update Share Records. API exposed to customers security: - iam-oauth2-schema: - ZohoCRM.share.leads.UPDATE - iam-oauth2-schema: - ZohoCRM.share.contacts.UPDATE - iam-oauth2-schema: - ZohoCRM.share.accounts.UPDATE - iam-oauth2-schema: - ZohoCRM.share.deals.UPDATE - iam-oauth2-schema: - ZohoCRM.share.products.UPDATE - iam-oauth2-schema: - ZohoCRM.share.tasks.UPDATE - iam-oauth2-schema: - ZohoCRM.share.events.UPDATE - iam-oauth2-schema: - ZohoCRM.share.calls.UPDATE - iam-oauth2-schema: - ZohoCRM.share.quotes.UPDATE - iam-oauth2-schema: - ZohoCRM.share.invoices.UPDATE - iam-oauth2-schema: - ZohoCRM.share.campaigns.UPDATE - iam-oauth2-schema: - ZohoCRM.share.vendors.UPDATE - iam-oauth2-schema: - ZohoCRM.share.pricebooks.UPDATE - iam-oauth2-schema: - ZohoCRM.share.salesorders.UPDATE - iam-oauth2-schema: - ZohoCRM.share.purchaseorders.UPDATE - iam-oauth2-schema: - ZohoCRM.share.solutions.UPDATE - iam-oauth2-schema: - ZohoCRM.share.cases.UPDATE - iam-oauth2-schema: - ZohoCRM.share.cross_sellings.UPDATE - iam-oauth2-schema: - ZohoCRM.share.next_buys.UPDATE - iam-oauth2-schema: - ZohoCRM.share.first_buys.UPDATE - iam-oauth2-schema: - ZohoCRM.share.rebuys.UPDATE - iam-oauth2-schema: - ZohoCRM.share.bundles.UPDATE - iam-oauth2-schema: - ZohoCRM.share.custom.UPDATE parameters: - $ref: '#/components/parameters/ModuleApiName_2' - $ref: '#/components/parameters/RecordId_2' requestBody: content: application/json: schema: type: object description: Update Share Records Request properties: share: type: array description: additional information maxItems: 20 items: type: object description: share record details properties: type: type: string description: type of sharing enum: - private - public share_related_records: type: boolean description: indicates if related records are shared permission: type: string description: level of access granted enum: - read_only - read_write - full_access shared_with: type: object description: details of whom the record is shared with properties: type: type: string description: type of entity with whom the record is shared enum: - roles - groups - users id: type: string description: id of the entity with whom the record is shared maxLength: 20 additionalProperties: false required: - type - id additionalProperties: false required: - type - permission - shared_with notify_shared_members: type: boolean description: indicates whether to notify the shared members notify_on_completion: type: boolean description: indicates whether to notify on completion additionalProperties: false required: - share required: true responses: '201': description: Update Share Records Success Response content: application/json: schema: description: Update Share Records Success Response type: object properties: share: type: array description: list of share record update responses maxItems: 20 items: type: object description: share record update response details properties: code: type: string description: response code enum: - SUCCESS details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - record will be shared successfully status: type: string description: response status enum: - success additionalProperties: false required: - code - details - message - status additionalProperties: false '400': description: Bad Request Response content: application/json: schema: description: bad request response type: object oneOf: - $ref: '#/components/schemas/InvalidShareWithValueErrorResponse' - $ref: '#/components/schemas/InvalidShareWithIdErrorResponse' - $ref: '#/components/schemas/ActivityModuleRelatedIssueErrorResponse' - $ref: '#/components/schemas/ShareLimitExceedErrorResponse' - $ref: '#/components/schemas/NotifyMembersWithoutFeeds' - $ref: '#/components/schemas/AmbiguousShareErrorResponse' - $ref: '#/components/schemas/MandatoryNotFound' - $ref: '#/components/schemas/InvalidTypeErrorResponse' - $ref: '#/components/schemas/MaximumLengthErrorResponse' - $ref: '#/components/schemas/InvalidRecordIdErrorResponse' - $ref: '#/components/schemas/InvalidModuleNameErrorResponse' - $ref: '#/components/schemas/UnsupportedModule' additionalProperties: true '403': description: Forbidden Response content: application/json: schema: type: object description: forbidden response oneOf: - $ref: '#/components/schemas/CommonForbiddenErrorResponse' - $ref: '#/components/schemas/SchedularAlreadyRunningErrorResponse' - $ref: '#/components/schemas/SharingSharedRecordErrorResponse' - $ref: '#/components/schemas/RecordLevelSharingNotSupportedForModuleErrorResponse' - $ref: '#/components/schemas/RecordForbiddenErrorResponse' - $ref: '#/components/schemas/NotifyMembersWithoutFeeds' additionalProperties: true tags: - Actions delete: operationId: deleteShareRecords summary: Delete Share Records description: Delete Share Records. API exposed to customers security: - iam-oauth2-schema: - ZohoCRM.share.leads.DELETE - iam-oauth2-schema: - ZohoCRM.share.contacts.DELETE - iam-oauth2-schema: - ZohoCRM.share.accounts.DELETE - iam-oauth2-schema: - ZohoCRM.share.deals.DELETE - iam-oauth2-schema: - ZohoCRM.share.products.DELETE - iam-oauth2-schema: - ZohoCRM.share.tasks.DELETE - iam-oauth2-schema: - ZohoCRM.share.events.DELETE - iam-oauth2-schema: - ZohoCRM.share.calls.DELETE - iam-oauth2-schema: - ZohoCRM.share.quotes.DELETE - iam-oauth2-schema: - ZohoCRM.share.invoices.DELETE - iam-oauth2-schema: - ZohoCRM.share.campaigns.DELETE - iam-oauth2-schema: - ZohoCRM.share.vendors.DELETE - iam-oauth2-schema: - ZohoCRM.share.pricebooks.DELETE - iam-oauth2-schema: - ZohoCRM.share.salesorders.DELETE - iam-oauth2-schema: - ZohoCRM.share.purchaseorders.DELETE - iam-oauth2-schema: - ZohoCRM.share.solutions.DELETE - iam-oauth2-schema: - ZohoCRM.share.cases.DELETE - iam-oauth2-schema: - ZohoCRM.share.cross_sellings.DELETE - iam-oauth2-schema: - ZohoCRM.share.next_buys.DELETE - iam-oauth2-schema: - ZohoCRM.share.first_buys.DELETE - iam-oauth2-schema: - ZohoCRM.share.rebuys.DELETE - iam-oauth2-schema: - ZohoCRM.share.bundles.DELETE - iam-oauth2-schema: - ZohoCRM.share.custom.DELETE parameters: - $ref: '#/components/parameters/ModuleApiName_2' - $ref: '#/components/parameters/RecordId_2' responses: '200': description: Deleted successfully content: application/json: schema: description: Revoke Sharing Success Response type: object properties: share: type: object description: share record revoke response details properties: code: type: string description: response code enum: - SUCCESS details: type: object description: additional information properties: id: type: string description: ID of the record whose sharing is revoked maxLength: 20 additionalProperties: false message: type: string description: response message enum: - Sharing Revoked status: type: string description: response status enum: - success additionalProperties: false required: - code - details - message - status additionalProperties: false '400': description: Bad Request content: application/json: schema: description: Revoke Sharing Bad Request Response type: object oneOf: - $ref: '#/components/schemas/NoSharingAvailableToRevokeErrorResponse' - $ref: '#/components/schemas/InvalidRecordIdErrorResponse' - $ref: '#/components/schemas/InvalidModuleNameErrorResponse' additionalProperties: true '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/CommonForbiddenErrorResponse' tags: - Actions /{module}/{recordId}/actions/associate_email: post: summary: Associate Email description: Associates emails to a specific record in a module. operationId: associateEmail security: - iam-oauth2-schema: - ZohoCRM.modules.emails.CREATE parameters: - name: module in: path required: true description: The API name of the module (e.g., Leads, Contacts). schema: type: string maxLength: 100 - name: recordId in: path required: true description: The unique ID of the record to associate the email with. schema: type: string maxLength: 100 requestBody: description: Payload containing the email details to be associated. required: true content: application/json: schema: $ref: '#/components/schemas/AssociateEmailRequest' responses: '200': description: Email associated successfully. content: application/json: schema: allOf: - $ref: '#/components/schemas/ActionResponse' '400': description: Bad Request. content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponse_2' tags: - Actions /{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_2' 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 tags: - Actions /{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 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 tags: - Actions /{module}/actions/mass_delete: post: operationId: massDelete summary: Mass delete with record ids and custom view id description: Mass delete records with record ids or custom view id parameters: - $ref: '#/components/parameters/Module_3' requestBody: description: Request body containing record IDs to delete or custom view ID (`cvid`) with or without territory. Maximum 500 IDs per request. content: application/json: schema: type: object description: Request body containing **either** record IDs to delete **or** custom view ID with optional territory filter. Maximum 500 IDs per request. properties: ids: type: array items: type: string pattern: ^[0-9]+$ format: string description: Record ID minItems: 1 maxItems: 500 description: Array of record IDs to delete. Mutually exclusive with `cvid`. cvid: type: string pattern: ^[0-9]+$ format: string description: Custom view ID. Mutually exclusive with `ids`. territory: type: object properties: id: type: string pattern: ^[0-9]+$ format: string description: Territory ID include_child: type: boolean description: Whether to include child territories. additionalProperties: false required: - id description: Territory filter for the delete operation (optional, only valid with `cvid`). oneOf: - description: ids passed for mass delete type: object properties: ids: description: record ids type: array items: description: record id type: string pattern: ^[0-9]+$ format: string minItems: 1 maxItems: 500 required: - ids additionalProperties: false - description: cvid with territory passed for mass delete type: object properties: cvid: description: custom view id type: string pattern: ^[0-9]+$ format: string territory: type: object properties: id: type: string pattern: ^[0-9]+$ format: string description: Territory ID include_child: type: boolean description: Whether to include child territories. additionalProperties: false required: - id description: Territory filter for the delete operation required: - cvid additionalProperties: false additionalProperties: false required: true responses: '200': description: Successfully deleted one or more records synchronously, or scheduled a batch delete operation asynchronously. content: application/json: schema: type: object description: Mass delete success response properties: data: description: Array of success responses (synchronous record deletions or batch job scheduling) type: array minItems: 1 maxItems: 500 items: oneOf: - description: Individual record deleted synchronously type: object properties: status: description: error status type: string const: success code: description: error code type: string const: SUCCESS message: description: error message type: string const: record is deleted details: description: error details type: object properties: id: type: string pattern: ^[0-9]+$ format: string description: ID of the deleted record. required: - id additionalProperties: false additionalProperties: false required: - status - code - message - details - description: Batch delete job scheduled asynchronously (cvid-based deletion) type: object properties: status: description: error status type: string const: success code: description: error code type: string const: SUCCESS message: description: error message type: string const: mass delete scheduled successfully details: description: error details type: object properties: job_id: type: string pattern: ^[0-9]+$ format: string description: Job ID for tracking the batch delete operation (use with GET endpoint). required: - job_id additionalProperties: false additionalProperties: false required: - status - code - message - details additionalProperties: false required: - data '207': description: 'Multi-Status: Some records deleted successfully, others failed validation. Each item in `data` represents an individual record result.' content: application/json: schema: description: 'Multi-Status: Some records deleted successfully, others failed validation. Each item in `data` represents an individual record result.' type: object properties: data: description: 'Multi-Status: Some records deleted successfully, others failed validation. Each item in `data` represents an individual record result.' type: array minItems: 1 maxItems: 500 items: oneOf: - type: object description: success response properties: status: type: string const: success description: Indicates successful deletion. code: type: string const: SUCCESS description: Success code. message: type: string const: record is deleted description: Confirmation message. details: description: record id type: object properties: id: type: string pattern: ^[0-9]+$ format: string description: ID of the deleted record. additionalProperties: false required: - id additionalProperties: false required: - status - code - message - details - description: Invalid id type: object properties: status: type: string const: error description: Indicates deletion failure. code: type: string enum: - INVALID_DATA description: Error code. message: type: string format: string description: Human-readable error description. details: description: record id type: object properties: id: type: string pattern: ^[0-9]+$ format: string description: ID of the record that failed deletion. additionalProperties: false required: - id additionalProperties: false required: - status - code - message - details additionalProperties: false required: - data '400': description: 'Bad Request: Invalid input (e.g., missing required fields, invalid data types, unsupported module, or malformed request body).' content: application/json: schema: oneOf: - description: Mandatory field record id or cvid is missing type: object properties: status: description: error status type: string const: error code: description: error code type: string const: MANDATORY_NOT_FOUND message: description: error message type: string const: required field not found details: description: error details type: object properties: api_name: type: string format: string description: Name of the missing required field. expected_data_type: type: string format: string description: Expected data type for the missing field. additionalProperties: false required: - api_name - expected_data_type additionalProperties: false required: - status - code - message - details - description: Invalid cvid or record id type: object properties: status: description: error status type: string const: error code: description: error code type: string const: INVALID_DATA message: type: string format: string description: Human-readable error description (e.g., 'invalid data', 'the cvid given seems to be invalid'). details: description: error details type: object properties: api_name: type: string format: string description: Name of the invalid field. json_path: type: string format: string description: JSON path to the invalid field (optional). id: type: string pattern: ^[0-9]+$ format: string description: Invalid record ID (optional). additionalProperties: false required: - api_name - json_path - id additionalProperties: false required: - status - code - message - details - description: Invalid module in request path type: object properties: status: description: error status type: string const: error code: description: error code type: string const: INVALID_MODULE message: description: error message type: string const: the module name given seems to be invalid details: description: error details type: object properties: resource_path_index: type: integer format: int32 const: 0 description: Index of the resource path segment containing the invalid module name. required: - resource_path_index additionalProperties: false additionalProperties: false required: - status - code - message - details - description: Mass delete is not supported for this module type: object properties: status: description: error status type: string const: error code: description: error code type: string const: NOT_SUPPORTED message: description: error message type: string format: string details: description: error details type: object properties: resource_path_index: type: integer format: int32 const: 0 description: Index of the unsupported resource path segment. additionalProperties: false required: - resource_path_index additionalProperties: false required: - status - code - message - details - description: No record present in custom view type: object properties: status: description: error status type: string const: error code: description: error code type: string const: NO_RECORDS_FOUND message: description: error message type: string const: no record found to update details: description: error details type: object additionalProperties: false additionalProperties: false required: - status - code - message - details security: - iam-oauth2-schema: - ZohoCRM.mass_delete.DELETE tags: - Actions get: operationId: getMassDeleteJobStatus summary: Retrieve mass delete job status description: Get the status and results of a previously scheduled mass delete operation by job ID. parameters: - $ref: '#/components/parameters/Module_3' - name: job_id in: query required: true schema: type: string pattern: ^[0-9]+$ format: string description: Job ID returned from the mass delete POST request. responses: '200': description: Job status retrieved successfully. Returns counts of total, deleted, and failed records. content: application/json: schema: description: Mass delete job status type: object properties: data: description: Mass delete job status type: array items: description: Mass delete job status type: object properties: Status: type: string enum: - COMPLETED - SCHEDULED - QUEUED - RUNNING - SUSPENDED - FAILED description: Current status of the mass delete job. Total_Count: type: integer format: int32 minimum: 0 description: Total number of records targeted for deletion. Deleted_Count: type: integer format: int32 minimum: 0 description: Number of records successfully deleted. Failed_Count: type: integer format: int32 minimum: 0 description: Number of records that failed to delete. additionalProperties: false required: - Status - Total_Count - Deleted_Count - Failed_Count minItems: 1 maxItems: 1 additionalProperties: false required: - data '400': description: 'Bad Request: Either the job_id parameter is missing or its format is invalid.' content: application/json: schema: oneOf: - description: Job id mandatory param is missing type: object properties: status: description: error status type: string const: error code: description: error code type: string const: MANDATORY_NOT_FOUND message: description: error message type: string const: mandatory param missing details: description: error details type: object properties: param_name: type: string const: job_id description: Name of the missing query parameter. required: - param_name additionalProperties: false additionalProperties: false required: - status - code - message - details - description: Job is seems to be invalid type: object properties: status: description: error status type: string const: error code: description: error code type: string const: INVALID_DATA message: description: error message type: string const: The jobid given seems to be invalid details: description: error details type: object properties: param_name: type: string const: job_id description: Name of the invalid query parameter. required: - param_name additionalProperties: false additionalProperties: false required: - status - code - message - details security: - iam-oauth2-schema: - ZohoCRM.mass_delete.READ tags: - Actions /{module}/actions/unenrol_from_cadences: post: summary: Unenroll records from cadences description: Un-Enroll records from the cadences operationId: postUnenrolFromCadences security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Events.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Products.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Activities.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.CREATE - iam-oauth2-schema: - ZohoCRM.modules.custom.CREATE parameters: - $ref: '#/components/parameters/Module_4' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostCadencesRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostcadencesResponse200' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: $ref: '#/components/schemas/PostcadencesResponse207' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore260315750' - $ref: '#/components/schemas/ErrorResponseCore1243473672' - $ref: '#/components/schemas/ErrorResponseCore814179042' - $ref: '#/components/schemas/ErrorResponseCore1362235056' - $ref: '#/components/schemas/ErrorResponseCore1414382895' - $ref: '#/components/schemas/ErrorResponseCore1137512454' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse403' tags: - Actions /{module}/actions/enrol_in_cadences: post: summary: Enroll records into cadences description: API to enroll records into manual cadence operationId: postEnrolInCadences security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Events.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Products.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Invoices.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Forecasts.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Activities.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Attachments.CREATE - iam-oauth2-schema: - ZohoCRM.modules.custom.CREATE parameters: - $ref: '#/components/parameters/Module_4' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostCadencesRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostcadencesResponse200' '207': description: Multi-Status — Response contains mixed status results content: application/json: schema: $ref: '#/components/schemas/PostcadencesResponse207' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponseCore260315750' - $ref: '#/components/schemas/ErrorResponseCore1243473672' - $ref: '#/components/schemas/ErrorResponseCore814179042' - $ref: '#/components/schemas/ErrorResponseCore1362235056' - $ref: '#/components/schemas/ErrorResponseCore1414382895' - $ref: '#/components/schemas/ErrorResponseCore1137512454' '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse403' tags: - Actions /{moduleApiName}/{id}/actions/convert: post: operationId: convertInventory summary: Convert an inventory record description: Converts the record into another inventory module type depending on the parent module:Quotes -> Sales Orders, Invoices :Sales Orders -> Invoices. parameters: - $ref: '#/components/parameters/ModuleApiName_3' - $ref: '#/components/parameters/Id_3' requestBody: content: application/json: schema: type: object description: Request payload for inventory convert operation. additionalProperties: false properties: data: type: array description: Holds inventory convert record details. maxItems: 1 items: type: object description: Holds inventory convert record details. additionalProperties: false properties: convert_to: type: array description: Array of target module where the record to be converted. maxItems: 1 items: type: object description: Holds target module details. additionalProperties: false properties: module: type: object description: Holds target module details. additionalProperties: false properties: api_name: type: string description: API name of the target module enum: - Invoices - Sales_Orders id: type: string maxLength: 255 description: Unique ID of the target module required: - api_name - id carry_over_tags: type: boolean description: Defines whether the tags in the source module to get converted to the target module required: - module required: - convert_to required: true responses: '200': description: Conversion successful. content: application/json: schema: type: object description: Successfully converted response additionalProperties: false properties: data: type: array description: Successfully converted response maxItems: 1 items: type: object description: Successfully converted response additionalProperties: false properties: code: type: string description: success enum: - SUCCESS message: type: string description: Converted response message enum: - The record has been converted successfully status: type: string description: success status enum: - success details: type: object description: Details of the converted record additionalProperties: false properties: Sales_Orders: type: object description: Details of the salesorders converted record additionalProperties: false properties: id: type: string maxLength: 255 description: Unique ID of the converted target record name: type: string maxLength: 50 description: Display name of the converted target record Invoices: type: object description: Details of the invoice converted record additionalProperties: false properties: id: type: string maxLength: 255 description: Unique ID of the converted target record name: type: string maxLength: 50 description: Display name of the converted target record '400': description: Bad Request — input validation or request-level errors. content: application/json: schema: oneOf: - type: object description: Validation error response. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA - MANDATORY_NOT_FOUND - ID_ALREADY_CONVERTED - NO_PERMISSION - AMBIGUITY_DURING_PROCESSING - EXPECTED_FIELD_MISSING - INVALID_REQUEST_METHOD - NOT_APPROVED - NOT_REVIEWED - RECORD_LOCKED maxLength: 100 message: type: string description: Human-readable error message. maxLength: 512 status: type: string description: Error status category. enum: - error maxLength: 50 details: type: object description: Additional error detail (field-level info, json path, expected types, limits, etc.). additionalProperties: true required: - code - message - status - details - type: object description: Validation error response. additionalProperties: false properties: data: type: array description: error response items: type: object description: data for the error response additionalProperties: false properties: code: type: string description: Error code. enum: - AMBIGUITY_DURING_PROCESSING - EXPECTED_FIELD_MISSING - NOT_ALLOWED - INVALID_DATA - DUPLICATE_DATA maxLength: 100 message: type: string description: Human-readable error message. maxLength: 512 status: type: string description: Error status category. enum: - error maxLength: 50 details: type: object description: Additional error detail (field-level info, json path, expected types, limits, etc.). additionalProperties: true required: - code - message - status - details maxItems: 4 required: - data description: Possible 400 response shapes for validation and related errors. '403': description: Permission denied content: application/json: schema: oneOf: - type: object description: Permission denied additionalProperties: false properties: data: type: array description: Permission denied maxItems: 4 items: type: object description: Permission denied additionalProperties: false properties: code: type: string description: Error code. enum: - NO_PERMISSION details: type: object description: Optional details object. additionalProperties: true message: type: string description: Human-readable message. maxLength: 512 status: type: string description: Status category. enum: - error maxLength: 50 required: - code - message - status - details required: - data - type: object description: Permission denied additionalProperties: false properties: code: type: string description: Error code. enum: - NO_PERMISSION details: type: object description: Optional details object. additionalProperties: true message: type: string description: Human-readable message. maxLength: 512 status: type: string description: Status category. enum: - error maxLength: 50 required: - code - details - message - status security: - iam-oauth2-schema: - ZohoCRM.modules.Quotes.CREATE - ZohoCRM.modules.SalesOrders.CREATE tags: - Actions /{moduleApiName}/{recordId}/actions/send_mail_merge: post: summary: POST /{module_API_name}/{recordId}/actions/send_mail_merge description: Send mail merge API to use a mail merge template and send emails to users. You can also attach files either as inline images or separate attachments with the email through the API. operationId: postSendMailMerge parameters: - $ref: '#/components/parameters/ParamPathModuleApiName' - $ref: '#/components/parameters/ParamPathRecordId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostsendmailmergeRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostsendmailmergeResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response schema for 400 status code oneOf: - $ref: '#/components/schemas/InvalidModulePathError' - $ref: '#/components/schemas/RequiredParamMissingError' - $ref: '#/components/schemas/InvalidDataParamError' - $ref: '#/components/schemas/InvalidRequestMethodError' - type: object additionalProperties: false description: Wrapped error response with send_mail_merge properties: send_mail_merge: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/MandatoryFieldNotFoundError' - $ref: '#/components/schemas/InvalidDataTypeError' - $ref: '#/components/schemas/InvalidDataMaxLengthError' maxItems: 25 required: - send_mail_merge security: - iam-oauth2-schema: - ZohoCRM.settings.mailmerge.CREATE,ZohoWriter.documentEditor.ALL,ZohoWriter.merge.ALL,ZohoCRM.settings.emails.ALL tags: - Actions /{moduleApiName}/{recordId}/actions/sign_mail_merge: post: summary: POST /{module_API_name}/{recordId}/actions/sign_mail_merge description: To send a mail merge document for signing and approval.To use this API, you must initially access the Merge and Sign dialogue from the Writer UI once. Please note that you need to do this only once. operationId: postSignMailMerge parameters: - $ref: '#/components/parameters/ParamPathModuleApiName' - $ref: '#/components/parameters/ParamPathRecordId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostsignmailmergeRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostsignmailmergeResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response schema for 400 status code oneOf: - $ref: '#/components/schemas/ExpectedFieldMissingError' - $ref: '#/components/schemas/InvalidDataParamError' - $ref: '#/components/schemas/InvalidModulePathError' - type: object additionalProperties: false description: Wrapped error response with sign_mail_merge properties: sign_mail_merge: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/MandatoryFieldNotFoundBodyError' - $ref: '#/components/schemas/MandatoryFieldNotFoundError' - $ref: '#/components/schemas/InvalidDataTypeError' - $ref: '#/components/schemas/InvalidDataMaxLengthError' maxItems: 25 required: - sign_mail_merge - $ref: '#/components/schemas/InvalidRequestMethodError' security: - iam-oauth2-schema: - ZohoCRM.settings.mailmerge.CREATE,ZohoWriter.documentEditor.ALL,ZohoWriter.merge.ALL,ZohoSign.documents.ALL tags: - Actions /{moduleApiName}/{recordId}/actions/download_mail_merge: post: summary: POST /{module_API_name}/{recordId}/actions/download_mail_merge description: Use the download mail merge API to download the merged document created using your mail merge template. operationId: postDownloadMailMerge parameters: - $ref: '#/components/parameters/ParamPathModuleApiName' - $ref: '#/components/parameters/ParamPathRecordId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostdownloadmailmergeRequest' responses: '200': description: OK - Successful response content: application/json: schema: type: object additionalProperties: false description: Response schema for download mail merge properties: download_mail_merge: type: array description: Array of download mail merge responses items: type: object additionalProperties: false description: Download mail merge response item properties: code: type: string description: Response code maxLength: 255 message: type: string description: Response message maxLength: 255 status: type: string description: Response status maxLength: 255 maxItems: 1 '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response schema for 400 status code oneOf: - $ref: '#/components/schemas/ExpectedParamMissingError' - $ref: '#/components/schemas/InvalidDataUrlError' - $ref: '#/components/schemas/InvalidModuleParamError' - $ref: '#/components/schemas/InvalidRequestMethodError' - type: object additionalProperties: false description: Wrapped error response with download_mail_merge properties: download_mail_merge: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/MandatoryFieldNotFoundError' - $ref: '#/components/schemas/InvalidDataTypeError' - $ref: '#/components/schemas/InvalidDataMaxLengthError' maxItems: 25 required: - download_mail_merge security: - iam-oauth2-schema: - ZohoCRM.settings.mailmerge.CREATE,ZohoWriter.documentEditor.ALL,ZohoWriter.merge.ALL tags: - Actions /{module}/actions/portal_invite: post: summary: Invite portal users description: Send invitations to portal users for a specific module. operationId: inviteUsers parameters: - $ref: '#/components/parameters/Module_5' security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.CREATE requestBody: content: application/json: schema: type: object description: Request body for inviting portal users additionalProperties: false properties: portal_invite: type: array description: List of portal invitation requests maxItems: 100 items: type: object description: Portal invitation request object additionalProperties: false properties: data: type: array description: Array of user invitation data maxItems: 100 items: type: object description: User invitation details additionalProperties: false properties: id: type: string description: User record ID maxLength: 255 user_type_id: type: string description: User type identifier maxLength: 255 type: type: string description: Invitation type enum: - reinvite - invite language: type: - string - 'null' description: Preferred language for the invitation enum: - '' - it_IT - ru_RU - pl_PL - tr_TR - hi_IN - pt_BR - th_TH - fr_FR - ja_JP - in_ID - cs_CZ - de_DE - hu_HU - zh_TW - es_ES - nl_NL - sv_SE - da_DK - bg_BG - vi_VN - iw_IL - hr_HR - en_GB - ko_KR - en_US - zh_CN - ar_EG - pt_PT - null required: - id - user_type_id - type required: - data required: - portal_invite required: true responses: '200': description: Portal user invitation successfully scheduled content: application/json: schema: type: object description: Response for portal user invitation requests additionalProperties: false properties: portal_invite: type: array description: List of portal invitation responses maxItems: 100 items: type: object description: Portal invitation response object additionalProperties: false properties: code: type: string description: Status code indicating invitation was scheduled enum: - SCHEDULED details: type: object description: Additional details about the scheduled invitation additionalProperties: false properties: job_id: type: string description: Unique identifier for the invitation job maxLength: 255 required: - job_id message: type: string description: Success message maxLength: 1000 status: type: string description: Status of the response enum: - success required: - code - details - message - status required: - portal_invite '400': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: Portal invite error response with array of errors additionalProperties: false properties: portal_invite: type: array description: List of portal invitation errors maxItems: 100 items: type: object description: Individual invitation error details additionalProperties: false properties: code: type: string description: Error code maxLength: 255 enum: - MANDATORY_NOT_FOUND - INVALID_DATA details: type: object description: Additional error details additionalProperties: true message: type: string description: Error message maxLength: 1000 status: type: string description: status message maxLength: 255 required: - code - message - status - details required: - portal_invite '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: oneOf: - type: object description: Invalid module error response additionalProperties: false properties: code: type: string description: Error code indicating invalid module enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status - type: object description: Portal invite error response with array of errors additionalProperties: false properties: portal_invite: type: array description: List of portal invitation errors maxItems: 100 items: type: object description: Individual invitation error details additionalProperties: false properties: code: type: string description: Error code maxLength: 255 message: type: string description: Error message maxLength: 1000 required: - code - message required: - portal_invite - type: object description: Alternative portal invite error format additionalProperties: false properties: portal_invite: type: array description: List of portal invitation error responses maxItems: 100 items: type: object description: Error response for invitation additionalProperties: true required: - portal_invite - type: object description: Additional portal invite error variant additionalProperties: false properties: portal_invite: type: array description: Array of invitation error objects maxItems: 100 items: type: object description: Portal invitation error item additionalProperties: true tags: - Actions get: summary: Invite portal users description: Send invitations to portal users for a specific module. operationId: getScheduledInviteUsersInfo parameters: - $ref: '#/components/parameters/Module_5' - name: job_id in: query required: false description: Job ID to fetch the status of the portal user invitations schema: type: string maxLength: 255 security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.READ responses: '200': description: Portal user invitation successfully scheduled content: application/json: schema: type: object description: Response for portal user invitation requests additionalProperties: false properties: portal_invite: type: array description: List of portal invitation responses maxItems: 100 items: type: object description: Portal invitation response object additionalProperties: false properties: data: type: array description: Status code indicating invitation was scheduled maxItems: 200 items: type: object description: Error response for invitation additionalProperties: false properties: details: type: object description: Record id of portal user additionalProperties: false properties: id: type: string description: Record id of portal user maxLength: 255 code: type: string description: Status code of the invitation enum: - SUCCESS - CANNOT_PROCESS - INVALID_DATA - REQUIRED_PARAM_MISSING - LICENSE_LIMIT_EXCEEDED - NOT_REVIEWED - NOT_APPROVED - DUPLICATE_DATA message: type: string description: Message of the success/error reason maxLength: 1000 status: type: string description: Status of the invitation enum: - success - error job_id: type: string description: Job ID to fetch the status of the portal user invitations maxLength: 255 status: type: string description: Status of the response enum: - scheduled - completed - in_progress required: - data - job_id - status required: - portal_invite tags: - Actions /{module}/{recordId}/actions/portal_invite: post: summary: Invite portal users description: Send invitations to portal users for a specific module. operationId: singleInviteUser security: - iam-oauth2-schema: - ZohoCRM.settings.clientportal.CREATE parameters: - $ref: '#/components/parameters/Module_5' - $ref: '#/components/parameters/RecordId_3' - name: language in: query required: false description: Preferred language for the invitation schema: type: string enum: - '' - it_IT - ru_RU - pl_PL - tr_TR - hi_IN - pt_BR - th_TH - fr_FR - ja_JP - in_ID - cs_CZ - de_DE - hu_HU - zh_TW - es_ES - nl_NL - sv_SE - da_DK - bg_BG - vi_VN - iw_IL - hr_HR - en_GB - ko_KR - en_US - zh_CN - ar_EG - pt_PT - name: user_type_id in: query required: true description: User type identifier schema: type: string maxLength: 255 - name: type in: query required: true description: Invitation type schema: type: string enum: - reinvite - invite responses: '200': description: Portal user invitation successfully scheduled content: application/json: schema: type: object description: Response for portal user invitation requests additionalProperties: false properties: portal_invite: type: array description: List of portal invitation responses maxItems: 100 items: type: object description: Portal invitation response object additionalProperties: false properties: code: type: string description: Status code indicating invitation was scheduled enum: - SUCCESS details: type: object description: Additional details about the scheduled invitation additionalProperties: false properties: record_id: type: string description: Record id of portal user maxLength: 255 required: - record_id message: type: string description: Success message maxLength: 1000 status: type: string description: Status of the response enum: - success required: - code - details required: - portal_invite '400': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: type: object description: Portal invite error response with array of errors additionalProperties: false properties: code: type: string description: Error code maxLength: 255 enum: - CANNOT_PROCESS - INVALID_DATA - REQUIRED_PARAM_MISSING - LICENSE_LIMIT_EXCEEDED - NOT_REVIEWED - NOT_APPROVED - DUPLICATE_DATA details: type: object description: Additional error details additionalProperties: true message: type: string description: Error message maxLength: 1000 status: type: string description: status message maxLength: 255 required: - code - message - status - details '403': description: Bad request - Invalid input parameters or validation errors content: application/json: schema: oneOf: - type: object description: Invalid module error response additionalProperties: false properties: code: type: string description: Error code indicating invalid module enum: - NO_PERMISSION message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional error details additionalProperties: true status: type: string description: Status of the response enum: - error required: - code - message - details - status - type: object description: Portal invite error response with array of errors additionalProperties: false properties: portal_invite: type: array description: List of portal invitation errors maxItems: 100 items: type: object description: Individual invitation error details additionalProperties: false properties: code: type: string description: Error code maxLength: 255 message: type: string description: Error message maxLength: 1000 required: - code - message required: - portal_invite - type: object description: Alternative portal invite error format additionalProperties: false properties: portal_invite: type: array description: List of portal invitation error responses maxItems: 100 items: type: object description: Error response for invitation additionalProperties: true required: - portal_invite - type: object description: Additional portal invite error variant additionalProperties: false properties: portal_invite: type: array description: Array of invitation error objects maxItems: 100 items: type: object description: Portal invitation error item additionalProperties: true tags: - Actions /{module}/{masterRecordId}/actions/merge: get: summary: Get Merge Job Status description: Retrieves the status of merge jobs for finding and tracking record merge operations in Zoho CRM modules. operationId: getMergeJobStatus parameters: - $ref: '#/components/parameters/JobId_2' - $ref: '#/components/parameters/MasterRecordId' - $ref: '#/components/parameters/Module_6' responses: '200': description: Successfully retrieved merge job status information content: application/json: schema: type: object description: Response containing merge job status information additionalProperties: false properties: merge: type: array description: Array of merge job status records maxItems: 100 items: type: object description: Individual merge job status additionalProperties: false properties: job_id: type: string description: Unique identifier of the merge job pattern: ^[0-9]+$ maxLength: 50 status: type: string description: Current status of the merge job enum: - SCHEDULED - running - completed - failed required: - job_id - status required: - merge '204': description: No merge jobs found for the specified criteria '400': description: Bad request due to validation errors, invalid data, or business rule violations content: application/json: schema: oneOf: - type: object description: Standard error response for invalid data or record issues additionalProperties: false properties: code: type: string description: Error code indicating the type of failure enum: - INVALID_DATA - INVALID_MODULE - NOT_ALLOWED details: type: object description: Additional error details with context information additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Index of the resource path parameter that caused the error api_name: type: string description: API name of the field or resource that caused the error maxLength: 100 json_path: type: string description: JSON path to the field that caused the error maxLength: 200 maximum_length: type: integer format: int32 description: Maximum allowed length for the field minimum_length: type: integer format: int32 description: Minimum required length for the field message: type: string description: Human-readable error message describing the issue maxLength: 500 status: type: string description: Status of the request enum: - error required: - code - message - status - type: object description: Error response with merge array structure additionalProperties: false properties: merge: type: array description: Array of error responses for merge operations maxItems: 10 items: type: object description: Individual merge operation error additionalProperties: false properties: code: type: string description: Error code for the specific merge operation enum: - MANDATORY_NOT_FOUND - NOT_ALLOWED - INVALID_DATA - DUPLICATE_DATA - DEPENDENT_FIELD_MISSING - LIMIT_EXCEEDED details: type: object description: Detailed error information for merge operation additionalProperties: false properties: api_name: type: string description: API name of the field that caused the error maxLength: 100 json_path: type: string description: JSON path to the problematic field maxLength: 200 resource_path_index: type: integer format: int32 description: Index of the resource path parameter maximum_length: type: integer format: int32 description: Maximum allowed length minimum_length: type: integer format: int32 description: Minimum required length MAXIMUM_SIZE: type: string description: Maximum size limit for files maxLength: 50 limit_due_to: type: array description: Fields that caused the limit to be exceeded maxItems: 20 items: type: object description: Field information for limit exceeded error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path data: type: array description: Data records with association information maxItems: 10 items: type: object description: Record with association details additionalProperties: false properties: id: type: string description: Record identifier pattern: ^[0-9]+$ maxLength: 50 _associated_places: type: array description: Associated places information maxItems: 50 items: type: object description: Association information additionalProperties: false properties: type: type: string description: Type of association maxLength: 100 resources: type: array description: Associated resources maxItems: 50 items: type: object description: Resource information additionalProperties: false properties: id: type: string description: Resource identifier pattern: ^[0-9]+$ maxLength: 50 name: type: string description: Resource name maxLength: 200 required: - id - name required: - type - resources required: - id dependee: type: object description: Dependent field information additionalProperties: false properties: api_name: type: string description: API name of the dependent field maxLength: 100 json_path: type: string description: JSON path to the dependent field maxLength: 200 required: - api_name - json_path message: type: string description: Error message for the merge operation maxLength: 500 status: type: string description: Status of the merge operation enum: - error required: - code - message - status required: - merge security: - iam-oauth2-schema: - ZohoCRM.modules.read tags: - Actions post: summary: Merge Records description: Merges duplicate records in Zoho CRM modules with field mapping and validation. Supports synchronous and asynchronous merge operations. operationId: mergeRecords parameters: - $ref: '#/components/parameters/MasterRecordId' - $ref: '#/components/parameters/Module_6' requestBody: content: application/json: schema: type: object description: Request body for merging records with field mapping and validation additionalProperties: false properties: merge: type: array description: Array of merge operations to be performed maxItems: 1 items: type: object description: Individual merge operation configuration additionalProperties: false properties: data: type: array description: Array of child records to be merged (minimum 1, maximum 2) minItems: 1 maxItems: 2 items: type: object description: Child record configuration for merge additionalProperties: false properties: id: type: string description: Unique identifier of the child record to be merged pattern: ^[0-9]+$ maxLength: 50 _fields: type: array description: Array of field configurations for the child record maxItems: 100 items: type: object description: Field configuration for merge operation additionalProperties: false properties: api_name: type: string description: API name of the field to be configured maxLength: 100 _data: oneOf: - type: array description: Array of file/image upload data maxItems: 50 items: type: object description: File or image upload information additionalProperties: false properties: id: type: string description: Unique identifier of the file or image pattern: ^[0-9]+$ maxLength: 50 required: - id - type: 'null' description: No file data (will delete all files for this field) required: - api_name required: - id master_record_fields: type: array description: Array of master record field configurations maxItems: 100 items: type: object description: Master record field configuration additionalProperties: false properties: api_name: type: string description: API name of the master record field maxLength: 100 _data: oneOf: - type: array description: Array of file/image upload data for master record maxItems: 50 items: type: object description: File or image upload information for master record additionalProperties: false properties: id: type: string description: Unique identifier of the file or image pattern: ^[0-9]+$ maxLength: 50 required: - id - type: 'null' description: No file data (will delete all files for this field) required: - api_name required: - data required: - merge required: true responses: '200': description: Records merged successfully content: application/json: schema: type: object description: Response for successful merge operation additionalProperties: false properties: merge: type: array description: Array of merge operation results maxItems: 1 items: type: object description: Individual merge operation result additionalProperties: false properties: code: type: string description: Success code for the merge operation enum: - SUCCESS details: type: object description: Details of the successful merge operation additionalProperties: false properties: id: type: string description: ID of the merged record pattern: ^[0-9]+$ maxLength: 50 required: - id message: type: string description: Success message for the merge operation maxLength: 500 status: type: string description: Status of the merge operation enum: - success required: - code - details - message - status required: - merge '201': description: Merge operation initiated - may be completed synchronously or scheduled asynchronously content: application/json: schema: oneOf: - type: object description: Response when merge operation is completed or scheduled additionalProperties: false properties: merge: type: array description: Array of merge operation results maxItems: 1 items: oneOf: - type: object description: Successful merge completion response additionalProperties: false properties: code: type: string description: Success code for completed merge enum: - SUCCESS details: type: object description: Details of the completed merge operation additionalProperties: false properties: id: type: string description: ID of the merged record pattern: ^[0-9]+$ maxLength: 50 required: - id message: type: string description: Success message for the merge operation maxLength: 500 status: type: string description: Status of the merge operation enum: - success required: - code - details - message - status - type: object description: Scheduled merge operation response additionalProperties: false properties: code: type: string description: Code indicating merge was scheduled enum: - SCHEDULED details: type: object description: Details of the scheduled merge operation additionalProperties: false properties: job_id: type: string description: Job ID for tracking the scheduled merge pattern: ^[0-9]+$ maxLength: 50 required: - job_id message: type: string description: Message about the scheduled merge operation maxLength: 500 status: type: string description: Status of the scheduling operation enum: - success required: - code - details - message - status required: - merge '202': description: Records scheduled for merge content: application/json: schema: type: object description: Response for scheduled merge operation additionalProperties: false properties: merge: type: array description: Array of scheduled merge operation results maxItems: 1 items: type: object description: Individual scheduled merge operation result additionalProperties: false properties: code: type: string description: Code indicating merge was scheduled enum: - SCHEDULED details: type: object description: Details of the scheduled merge operation additionalProperties: false properties: job_id: type: string description: Job ID for tracking the scheduled merge pattern: ^[0-9]+$ maxLength: 50 required: - job_id message: type: string description: Message about the scheduled merge operation maxLength: 500 status: type: string description: Status of the scheduling operation enum: - success required: - code - details - message - status required: - merge '204': description: No content - merge operation completed without additional data to return '400': description: Bad request due to validation errors, invalid data, or business rule violations content: application/json: schema: oneOf: - type: object description: Standard error response for invalid data or record issues additionalProperties: false properties: code: type: string description: Error code indicating the type of failure enum: - INVALID_DATA - INVALID_MODULE - NOT_ALLOWED details: type: object description: Additional error details with context information additionalProperties: false properties: resource_path_index: type: integer format: int32 description: Index of the resource path parameter that caused the error api_name: type: string description: API name of the field or resource that caused the error maxLength: 100 json_path: type: string description: JSON path to the field that caused the error maxLength: 200 maximum_length: type: integer format: int32 description: Maximum allowed length for the field minimum_length: type: integer format: int32 description: Minimum required length for the field message: type: string description: Human-readable error message describing the issue maxLength: 500 status: type: string description: Status of the request enum: - error required: - code - message - status - type: object description: Error response with merge array structure additionalProperties: false properties: merge: type: array description: Array of error responses for merge operations maxItems: 10 items: type: object description: Individual merge operation error additionalProperties: false properties: code: type: string description: Error code for the specific merge operation enum: - MANDATORY_NOT_FOUND - NOT_ALLOWED - INVALID_DATA - DUPLICATE_DATA - DEPENDENT_FIELD_MISSING - LIMIT_EXCEEDED details: type: object description: Detailed error information for merge operation additionalProperties: false properties: api_name: type: string description: API name of the field that caused the error maxLength: 100 json_path: type: string description: JSON path to the problematic field maxLength: 200 resource_path_index: type: integer format: int32 description: Index of the resource path parameter maximum_length: type: integer format: int32 description: Maximum allowed length minimum_length: type: integer format: int32 description: Minimum required length MAXIMUM_SIZE: type: string description: Maximum size limit for files maxLength: 50 limit_due_to: type: array description: Fields that caused the limit to be exceeded maxItems: 20 items: type: object description: Field information for limit exceeded error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path data: type: array description: Data records with association information maxItems: 10 items: type: object description: Record with association details additionalProperties: false properties: id: type: string description: Record identifier pattern: ^[0-9]+$ maxLength: 50 _associated_places: type: array description: Associated places information maxItems: 50 items: type: object description: Association information additionalProperties: false properties: type: type: string description: Type of association maxLength: 100 resources: type: array description: Associated resources maxItems: 50 items: type: object description: Resource information additionalProperties: false properties: id: type: string description: Resource identifier pattern: ^[0-9]+$ maxLength: 50 name: type: string description: Resource name maxLength: 200 required: - id - name required: - type - resources required: - id dependee: type: object description: Dependent field information additionalProperties: false properties: api_name: type: string description: API name of the dependent field maxLength: 100 json_path: type: string description: JSON path to the dependent field maxLength: 200 required: - api_name - json_path message: type: string description: Error message for the merge operation maxLength: 500 status: type: string description: Status of the merge operation enum: - error required: - code - message - status required: - merge security: - iam-oauth2-schema: - ZohoCRM.modules.CREATE tags: - Actions /actions/watch: get: operationId: getNotifications summary: List active notification channels description: Get a list of all active notification channels for the user. security: - iam-oauth2-schema: - ZohoCRM.notifications.READ parameters: - $ref: '#/components/parameters/Module_7' - $ref: '#/components/parameters/ChannelId' responses: '200': description: Successfully retrieved the list of notification channels. content: application/json: schema: additionalProperties: false type: object description: A wrapper for the list of notification channels and pagination information. properties: watch: type: array description: List of active notification channels. maxItems: 200 items: additionalProperties: false description: Notification channel details. type: object properties: notify_on_related_action: description: Whether to notify on related associated record actions. type: boolean channel_expiry: type: string format: date-time description: Channel expiry timestamp. return_affected_field_values: description: Whether to return affected field values in notification payloads. type: boolean resource_uri: maxLength: 255 description: URI of the resource. type: string resource_id: maxLength: 64 description: Identifier of the resource. type: string notify_url: maxLength: 255 description: Callback URL for notifications. type: string resource_name: maxLength: 128 description: Name of the resource. type: string fields: description: Fields to include in the notification. type: - array - 'null' items: {} notification_condition: description: Conditions for notifications. type: - array - 'null' items: additionalProperties: false description: Notification condition details. type: object properties: field_selection: additionalProperties: false description: Field selection details. type: object properties: group_operator: maxLength: 3 description: Operator for grouping conditions. type: string group: maxItems: 2 description: Group of field conditions. type: array items: additionalProperties: false description: Field condition details. type: object properties: field: additionalProperties: false description: Field details. type: object properties: api_name: maxLength: 128 description: API name of the field. type: string id: maxLength: 64 description: Identifier of the field. type: string group_operator: description: Operator for grouping sub-conditions. type: - string - 'null' enum: - and - or - null group: description: Sub-group of field conditions. type: - array - 'null' items: {} module: additionalProperties: false description: Module details. type: object properties: api_name: maxLength: 255 description: API name of the module. type: string id: maxLength: 64 description: Identifier of the module. type: string type: maxLength: 32 description: Type of notification condition. type: string channel_id: maxLength: 64 description: Identifier of the notification channel. type: string events: maxItems: 10 description: Events subscribed for notifications. type: array items: maxLength: 128 description: Event name. type: string token: type: - string - 'null' maxLength: 255 description: Verification token for the notification channel. info: additionalProperties: false description: Information about the pagination and record count. type: object properties: per_page: maximum: 200 description: Number of records per page. type: integer format: int32 count: maximum: 100 description: Total number of records returned. type: integer format: int32 page: maximum: 100 description: Current page number. type: integer format: int32 more_records: description: Indicates if more records are available. type: boolean '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' tags: - Actions post: operationId: createNotifications summary: Create notification channels description: Create one or more notification channels. security: - iam-oauth2-schema: - ZohoCRM.notifications.CREATE - iam-oauth2-schema: - ZohoCRM.notifications.ALL requestBody: required: true content: application/json: schema: type: object description: Create channels request wrapper. additionalProperties: false properties: watch: type: array description: Channels to create. maxItems: 50 items: type: object description: Create channel payload. additionalProperties: false properties: notify_url: type: string description: Callback URL. maxLength: 255 channel_id: type: string description: client channel identifier. maxLength: 64 channel_expiry: type: string description: Channel expiry time. format: date-time events: type: array description: Events to subscribe. maxItems: 50 items: type: string description: Event name. maxLength: 128 token: type: string description: Optional token echoed in callbacks. maxLength: 256 required: - notify_url - events required: - watch responses: '201': description: Notification channels created successfully. content: application/json: schema: type: object description: Creation results wrapper. additionalProperties: false properties: watch: type: array description: List of create result entries. maxItems: 50 items: type: object description: Single create result. additionalProperties: false properties: code: type: string description: Result code. maxLength: 32 details: type: object description: Created event channel details. additionalProperties: false properties: events: type: array description: Event channel details. maxItems: 50 items: type: object description: Event channel detail. additionalProperties: false properties: channel_expiry: type: string format: date-time description: Expiry timestamp. resource_uri: type: string description: Resource URI. maxLength: 255 resource_id: type: string description: Resource identifier. maxLength: 64 resource_name: type: string description: Resource name. maxLength: 128 channel_id: type: string description: Channel identifier. maxLength: 64 required: - channel_expiry - resource_uri - resource_id - resource_name - channel_id required: - events message: type: string description: Human readable message. maxLength: 255 status: type: string description: Status string. maxLength: 32 required: - code - details - message - status required: - watch '207': $ref: '#/components/responses/MultiStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' tags: - Actions put: operationId: updateNotificationDetails summary: Update full notification details description: Replace all details of an existing notification channel, overwriting its previous configuration. security: - iam-oauth2-schema: - ZohoCRM.notifications.UPDATE - iam-oauth2-schema: - ZohoCRM.notifications.ALL requestBody: required: true content: application/json: schema: type: object description: Full details update request wrapper (replaces existing). additionalProperties: false properties: watch: type: array description: Channels to update. maxItems: 50 items: type: object description: Full channel details replacement payload. additionalProperties: false properties: channel_id: type: string description: Channel identifier. maxLength: 64 notify_url: type: string description: Callback URL. maxLength: 255 channel_expiry: type: string format: date-time description: Expiry timestamp (<= 1 week). events: type: array description: Event subscriptions replacing current list. maxItems: 50 items: type: string description: Event spec module.operation maxLength: 128 notification_condition: type: array description: Conditions replacing existing (see update_info). maxItems: 2 items: type: object description: Condition object. additionalProperties: false properties: type: type: string description: Condition type enum: - field_selection required: - type notify_on_related_action: type: boolean description: Notify on related associated record actions. return_affected_field_values: type: boolean description: Return affected field values in notification payloads. token: type: string description: Verification token. maxLength: 256 required: - channel_id - notify_url - events responses: '200': description: Notification details replaced successfully. content: application/json: schema: type: object description: Full replacement result wrapper. additionalProperties: false properties: watch: type: array description: List of replacement result entries. maxItems: 50 items: type: object description: Single replacement result. additionalProperties: false properties: code: type: string description: Result code. maxLength: 32 details: type: object description: Replacement details container. additionalProperties: false properties: events: type: array description: Replaced event channel details. maxItems: 50 items: type: object description: Event channel detail. additionalProperties: false properties: channel_expiry: type: string format: date-time description: Expiry timestamp. resource_uri: type: string description: Resource URI. maxLength: 255 resource_id: type: string description: Resource identifier. maxLength: 64 resource_name: type: string description: Resource name. maxLength: 128 channel_id: type: string description: Channel identifier. maxLength: 64 required: - channel_expiry - resource_uri - resource_id - resource_name - channel_id required: - events message: type: string description: Human readable message. maxLength: 255 status: type: string description: Status string. maxLength: 32 required: - code - details - message - status required: - watch '207': $ref: '#/components/responses/MultiStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' tags: - Actions patch: operationId: updateNotificationInfo summary: Update specific notification information description: Partially update selected properties of a notification channel (URL, events, expiry, conditions, token). parameters: - $ref: '#/components/parameters/ChannelId' security: - iam-oauth2-schema: - ZohoCRM.notifications.UPDATE - iam-oauth2-schema: - ZohoCRM.notifications.ALL requestBody: required: true content: application/json: schema: type: object description: Update specific notification info request wrapper. additionalProperties: false properties: channel_id: type: string description: Channel identifier to update. maxLength: 64 notify_url: type: string description: Destination callback URL. maxLength: 255 channel_expiry: type: string format: date-time description: New expiry timestamp (<= 1 week). events: type: array description: Updated event subscriptions. maxItems: 50 items: type: string description: Event spec module.operation maxLength: 128 notification_condition: type: array description: Conditional field selection groups (max 2 objects). maxItems: 2 items: type: object description: Single condition definition. additionalProperties: false properties: type: type: string description: 'Condition type: field_selection' enum: - field_selection module: type: object description: Module context for field selection. additionalProperties: false properties: api_name: type: string description: Module API name. maxLength: 64 id: type: string description: Module ID. maxLength: 32 required: - api_name field_selection: type: object description: Field selection grouping. additionalProperties: false properties: group_operator: type: string description: Group operator. enum: - and - or group: type: array description: Field references (max 10). maxItems: 10 items: type: object description: Field reference. additionalProperties: false properties: api_name: type: string description: Field API name. maxLength: 64 id: type: string description: Field ID. maxLength: 32 required: - api_name required: - group_operator - group required: - type - module - field_selection notify_on_related_action: type: boolean description: Notify on related action flag. return_affected_field_values: type: boolean description: Return affected field values in notification payloads. token: type: string description: Verification token. maxLength: 256 required: - channel_id - notify_url - events responses: '200': description: Notification information updated successfully. content: application/json: schema: type: object description: Update info result wrapper. additionalProperties: false properties: watch: type: array maxItems: 50 description: List of update result entries. items: type: object description: Single update result. additionalProperties: false properties: code: type: string description: Result code. maxLength: 32 details: type: object description: Update details container. additionalProperties: false properties: events: type: array description: Updated event channel details. maxItems: 50 items: type: object description: Updated event channel detail. additionalProperties: false properties: channel_expiry: type: string format: date-time description: Expiry timestamp. resource_uri: type: string description: Resource URI. maxLength: 255 resource_id: type: string description: Resource identifier. maxLength: 64 resource_name: type: string description: Resource name. maxLength: 128 channel_id: type: string description: Channel identifier. maxLength: 64 required: - channel_expiry - resource_uri - resource_id - resource_name - channel_id required: - events message: type: string description: Human readable message. maxLength: 255 status: type: string description: Status string. maxLength: 32 required: - code - details - message - status required: - watch '207': $ref: '#/components/responses/MultiStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' tags: - Actions delete: operationId: disableNotifications summary: Disable notification channels description: Disable one or more notification channels identified by the channel_ids query parameter. parameters: - $ref: '#/components/parameters/ChannelIds' security: - iam-oauth2-schema: - ZohoCRM.notifications.DELETE - iam-oauth2-schema: - ZohoCRM.notifications.ALL responses: '200': description: Notification channels disabled. content: application/json: schema: type: object description: Disable result wrapper. additionalProperties: false properties: watch: type: array description: List of disable result entries. maxItems: 200 items: type: object description: Single disable result. additionalProperties: false properties: code: type: string description: Result code. maxLength: 32 details: type: object description: Disable details container. additionalProperties: false properties: resource_uri: type: string description: Resource URI. maxLength: 255 resource_id: type: string description: Resource identifier. maxLength: 64 channel_id: type: string description: Channel identifier disabled. maxLength: 64 required: - resource_uri - resource_id - channel_id message: type: string description: Human readable message. maxLength: 255 status: type: string description: Status string. maxLength: 32 required: - code - details - message - status required: - watch '207': $ref: '#/components/responses/MultiStatus' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' tags: - Actions /{module}/actions/unblock_email: post: operationId: unblockEmailByModule summary: Unblock bulk emails in a module description: Unblock emails for multiple records in a module. parameters: - $ref: '#/components/parameters/Module_8' requestBody: content: application/json: schema: type: object description: Request body for unblocking emails in bulk additionalProperties: false properties: ids: type: array description: List of record IDs to unblock emails for maxItems: 100 items: type: string description: Record ID maxLength: 50 unblock_fields: type: array description: Fields to unblock maxItems: 2 items: type: string description: Field name to unblock enum: - Email required: - ids - unblock_fields required: true responses: '200': description: Successful response when emails are unblocked content: application/json: schema: type: object description: Response object containing unblock email results additionalProperties: false properties: data: type: array description: Array of unblock operation results maxItems: 100 items: type: object description: Individual record unblock result additionalProperties: false properties: code: type: string description: Status code of the operation enum: - SUCCESS details: type: object description: Details of the unblocked record additionalProperties: false properties: id: type: string description: ID of the unblocked record maxLength: 50 required: - id message: type: string description: Response message maxLength: 255 status: type: string description: Status of the operation maxLength: 50 required: - code - details - message - status required: - data '400': description: Bad request - invalid parameters or data content: application/json: schema: oneOf: - type: object description: Error response for authentication or validation issues additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_URL_PATTERN - INVALID_DATA - INVALID_REQUEST_METHOD - INVALID_TOKEN message: type: string description: Error message enum: - invalid oauth token details: type: object description: Additional error details additionalProperties: true required: - status - code - message - details - type: object description: Error response for module or request issues additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_URL_PATTERN - INVALID_DATA - INVALID_REQUEST_METHOD - INVALID_MODULE message: type: string description: Error message enum: - invalid oauth token - Invalid record provided - the module name given seems to be invalid details: type: object description: Additional error details with resource path index additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource in the path format: int32 required: - status - code - message - details - type: object description: Error response for data validation or mandatory field issues additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - INVALID_MODULE - MANDATORY_NOT_FOUND message: type: string description: Error message maxLength: 500 details: oneOf: - type: object description: Details with expected data type information additionalProperties: false properties: expected_data_type: type: string description: Expected data type maxLength: 50 api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 1000 - type: object description: Details without expected data type additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 1000 required: - status - code - message - details security: - iam-oauth2-schema: - ZohoCRM.settings.emails.CREATE tags: - Actions /{module}/{id}/actions/unblock_email: post: operationId: unblockEmailById summary: Unblock single email description: Unblock email for a single record in a module. parameters: - $ref: '#/components/parameters/Module_8' - $ref: '#/components/parameters/Id_4' requestBody: content: application/json: schema: type: object description: Request body for unblocking email for a single record additionalProperties: false properties: unblock_fields: type: array description: Fields to unblock maxItems: 1 items: type: string description: Field name to unblock enum: - Email required: - unblock_fields required: true responses: '200': description: Successful response when email is unblocked content: application/json: schema: type: object description: Response object for single record email unblock additionalProperties: false properties: code: type: string description: Status code of the operation enum: - SUCCESS details: type: object description: Details of the unblocked record additionalProperties: false properties: id: type: string description: ID of the unblocked record maxLength: 50 required: - id message: type: string description: Response message maxLength: 255 status: type: string description: Status of the operation maxLength: 255 required: - code - details - message - status '400': description: Bad request - invalid parameters or data content: application/json: schema: oneOf: - type: object description: Error response for authentication or validation issues additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_URL_PATTERN - INVALID_DATA - INVALID_REQUEST_METHOD - INVALID_TOKEN message: type: string description: Error message enum: - invalid oauth token details: type: object description: Additional error details additionalProperties: true required: - status - code - message - details - type: object description: Error response for module or request issues additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_URL_PATTERN - INVALID_DATA - INVALID_REQUEST_METHOD - INVALID_MODULE message: type: string description: Error message enum: - invalid oauth token - Invalid record provided - the module name given seems to be invalid details: type: object description: Additional error details with resource path index additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource in the path format: int32 required: - status - code - message - details - type: object description: Error response for data validation or mandatory field issues additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - INVALID_MODULE - MANDATORY_NOT_FOUND message: type: string description: Error message maxLength: 500 details: oneOf: - type: object description: Details with expected data type information additionalProperties: false properties: expected_data_type: type: string description: Expected data type maxLength: 255 api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 1000 - type: object description: Details without expected data type additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 1000 required: - status - code - message - details security: - iam-oauth2-schema: - ZohoCRM.settings.emails.CREATE tags: - Actions /{moduleApiName}/actions/fetch_full_data: get: summary: Fetch full data for multiple records operationId: fetchFullDataForMultipleRecords parameters: - $ref: '#/components/parameters/ModuleApiName_4' - $ref: '#/components/parameters/Fields' required: true - $ref: '#/components/parameters/Ids' description: Fetches the full content of rich text fields for multiple records. The 'fields' parameter is mandatory and supports a maximum of 8 rich text fields. responses: '200': description: Successful response containing the full content of rich text fields for the requested records. content: application/json: schema: type: object description: Response containing full content of rich text fields additionalProperties: false properties: data: type: array description: Array of records with their rich text field content maxItems: 200 items: type: object description: Record with rich text field values properties: id: type: string description: The unique identifier of the record. format: int64 additionalProperties: type: string description: The full content of a rich text field, including HTML formatting. The property name corresponds to the API name of the rich text field. maxLength: 50000 required: - id required: - data '204': $ref: '#/components/responses/NoContentResponse' '400': description: Bad Request. The request could not be understood or was missing required parameters. content: application/json: schema: description: Error response for multiple records fetch full data operation oneOf: - type: object description: Invalid module error response additionalProperties: false properties: code: type: string enum: - INVALID_MODULE description: Error code indicating the module api name is invalid. details: type: object description: Error details with resource path index 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: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status - type: object description: Required parameter missing error response additionalProperties: false properties: code: type: string enum: - REQUIRED_PARAM_MISSING description: Error code indicating a required parameter is missing. details: type: object description: Error details with parameter name additionalProperties: false properties: param_name: type: string description: The name of the missing parameter. maxLength: 100 required: - param_name message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status - type: object description: Invalid request error response additionalProperties: false properties: code: type: string enum: - INVALID_REQUEST description: Error code indicating the request is invalid. details: type: object description: Additional details about the error. additionalProperties: true message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status '401': $ref: '#/components/responses/UnauthorizedError' '500': $ref: '#/components/responses/InternalServerError_2' security: - iam-oauth2-schema: - ZohoCRM.modules.READ tags: - Actions /{moduleApiName}/{id}/actions/fetch_full_data: get: summary: Fetch full data for a single record operationId: fetchFullDataForSingleRecord parameters: - $ref: '#/components/parameters/ModuleApiName_4' - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Id_5' description: Fetches the full content of rich text fields for a specific record. If the 'fields' parameter is not provided, all rich text fields in the module will be fetched. responses: '200': description: Successful response containing the full content of rich text fields for the requested records. content: application/json: schema: type: object description: Response containing full content of rich text fields additionalProperties: false properties: data: type: array description: Array of records with their rich text field content maxItems: 1 items: type: object description: Record with rich text field values properties: id: type: string description: The unique identifier of the record. format: int64 additionalProperties: type: string description: The full content of a rich text field, including HTML formatting. The property name corresponds to the API name of the rich text field. maxLength: 50000 required: - id required: - data '204': $ref: '#/components/responses/NoContentResponse' '400': description: Bad Request. The request could not be understood or was missing required parameters. content: application/json: schema: description: Error response for single record fetch full data operation oneOf: - type: object description: Invalid module error response additionalProperties: false properties: code: type: string enum: - INVALID_MODULE description: Error code indicating the module api name is invalid. details: type: object description: Error details with resource path index 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: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status - type: object description: Invalid request error response additionalProperties: false properties: code: type: string enum: - INVALID_REQUEST description: Error code indicating the request is invalid. details: type: object description: Additional details about the error. additionalProperties: true message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status '401': $ref: '#/components/responses/UnauthorizedError' '500': $ref: '#/components/responses/InternalServerError_2' security: - iam-oauth2-schema: - ZohoCRM.modules.READ tags: - Actions /{module}/{record}/actions/assign_territories: post: operationId: asssignTerritoriesToRecord security: - iam-oauth2-schema: - ZohoCRM.modules.UPDATE parameters: - $ref: '#/components/parameters/Record_3' description: No description provided. - $ref: '#/components/parameters/Module_9' description: No description provided. requestBody: content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 Territories: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `items` field of type `object`. additionalProperties: false description: The `Territories` property. maxItems: 100 required: - Territories description: The `items` field of type `object`. additionalProperties: false description: The `data` property. maxItems: 100 required: - data description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '202': description: Successful response. content: application/json: schema: x-zs-$id: AssignTerritoriesAccountRuleCriteriaGET $ref: '#/components/schemas/TerritorySchedueledSuccessCode' description: Scheduled Success Code '400': description: Error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryAssignInvalidDataTerritoryId' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataOnURL' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignMandatoryNotFound' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignDuplicateData' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNoPermission' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNotSupported' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignAlreadyUsed' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignRecordLocked' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataMaxLen' description: Territory Assign Invalid Error Schema On Request Body - type: object description: A `object` value. additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/TerritoryLimitExceededErrorSchema' description: Limit Exceeds. description: The `data` property. maxItems: 100 - $ref: '#/components/schemas/InvalidModule' description: Invalid Module description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: TerritoryAssignForbiddenError $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: x-zs-$id: AssignTerritoryInternalServerError description: The `schema` field. $ref: '#/components/schemas/TerritoryInternalServerErrorSchema' summary: Asssign Territories To Record description: Auto-generated description for operation `Asssign Territories To Record`. tags: - Actions /{module}/actions/assign_territories: post: operationId: asssignTerritoriesToRecords security: - iam-oauth2-schema: - ZohoCRM.modules.UPDATE parameters: - $ref: '#/components/parameters/Module_9' description: No description provided. requestBody: content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 Territories: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `items` field of type `object`. additionalProperties: false description: The `Territories` property. maxItems: 100 required: - id - Territories description: The `items` field of type `object`. additionalProperties: false description: The `data` property. maxItems: 100 required: - data description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '202': description: Successful response. content: application/json: schema: x-zs-$id: AssignTerritoryAccountRuleCriteriaGET $ref: '#/components/schemas/TerritorySchedueledSuccessCode' description: Scheduled Success Code '400': description: Error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryAssignInvalidDataTerritoryId' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataOnURL' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignMandatoryNotFound' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignDuplicateData' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNoPermission' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNotSupported' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignAlreadyUsed' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignRecordLocked' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataMaxLen' description: Territory Assign Invalid Error Schema On Request Body - type: object description: A `object` value. additionalProperties: false properties: data: type: array items: oneOf: - $ref: '#/components/schemas/TerritoryLimitExceededErrorSchema' description: Limit Exceeds. description: The `items` field. description: The `data` property. maxItems: 100 - $ref: '#/components/schemas/InvalidModule' description: Invalid Module description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: AssignTerritoryAssignForbiddenError $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. summary: Asssign Territories To Records description: Auto-generated description for operation `Asssign Territories To Records`. tags: - Actions /{module}/{record}/actions/remove_territories: post: operationId: removeTerritoriesToRecord security: - iam-oauth2-schema: - ZohoCRM.modules.UPDATE parameters: - $ref: '#/components/parameters/Record_3' description: No description provided. - $ref: '#/components/parameters/Module_9' description: No description provided. requestBody: content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 Territories: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `items` field of type `object`. additionalProperties: false description: The `Territories` property. maxItems: 100 required: - Territories description: The `items` field of type `object`. additionalProperties: false description: The `data` property. maxItems: 100 required: - data description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '202': description: Successful response. content: application/json: schema: x-zs-$id: RemoveTerritoryAccountRuleCriteriaGET $ref: '#/components/schemas/TerritorySchedueledSuccessCode' description: Scheduled Success Code '400': description: Error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryAssignInvalidDataTerritoryId' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataOnURL' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignMandatoryNotFound' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignDuplicateData' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNoPermission' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNotSupported' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignAlreadyUsed' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignRecordLocked' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataMaxLen' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/InvalidModule' description: Invalid Module - $ref: '#/components/schemas/NotSupportedForRemoveTerritoryRecord' description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: RemoveTerritoryAssignForbiddenError $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. summary: Remove Territories To Record description: Auto-generated description for operation `Remove Territories To Record`. tags: - Actions /{module}/actions/remove_territories: post: operationId: removeTerritoriesToRecords security: - iam-oauth2-schema: - ZohoCRM.modules.UPDATE parameters: - $ref: '#/components/parameters/Module_9' description: No description provided. requestBody: content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 Territories: type: array items: type: object properties: id: type: string description: The `id` property. maxLength: 100 required: - id description: The `items` field of type `object`. additionalProperties: false description: The `Territories` property. maxItems: 100 required: - id - Territories description: The `items` field of type `object`. additionalProperties: false description: The `data` property. maxItems: 100 required: - data description: The `schema` field of type `object`. additionalProperties: false required: true description: The `requestBody` field. responses: '202': description: Successful response. content: application/json: schema: x-zs-$id: RemoveTerritoriesAccountRuleCriteriaGET $ref: '#/components/schemas/TerritorySchedueledSuccessCode' description: Scheduled Success Code '400': description: Error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TerritoryAssignInvalidDataTerritoryId' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignMandatoryNotFound' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignDuplicateData' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNoPermission' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignNotSupported' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignAlreadyUsed' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignRecordLocked' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/TerritoryAssignInvalidDataMaxLen' description: Territory Assign Invalid Error Schema On Request Body - $ref: '#/components/schemas/InvalidModule' description: Invalid Module description: The `schema` field. '403': description: 'Territories Get Error Response ' content: application/json: schema: x-zs-$id: RemoveTerritoriesAssignForbiddenError $ref: '#/components/schemas/TerritoryErrorPermissionDenied' description: Territory Not yet Enabled. '500': description: Server error response. content: application/json: schema: oneOf: - type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false description: The `schema` field. summary: Remove Territories To Records description: Auto-generated description for operation `Remove Territories To Records`. tags: - Actions /{module}/actions/mass_update: post: summary: Mass Update API description: Enables users to update a specific field value across multiple records within a CRM module. operationId: idsUpdate parameters: - $ref: '#/components/parameters/Module_10' requestBody: content: application/json: schema: description: The request body must include `ids`, a list of record identifiers, and `data`, an array of objects mapping field API names to their new values. type: object properties: data: description: An array of objects mapping field API names to their new values. type: array items: description: Objects mapping field API names to their new values. type: object additionalProperties: true maxItems: 1 ids: description: Record ids type: array items: description: Record id type: string pattern: ^[0-9]+$ format: int64 maxItems: 500 additionalProperties: false required: - data - ids required: true responses: '200': description: Indicates that the mass update operation was completed successfully content: application/json: schema: description: Schema for a successful mass update response type: object properties: data: description: Array containing the response for each record type: array items: description: Response indicating a successful record update type: object properties: code: type: string description: Indicates the result of the operation with a response code enum: - SUCCESS details: description: Details of the record that was updated type: object properties: id: type: string description: Record id pattern: ^[0-9]+$ format: int64 Modified_Time: type: string format: date-time description: The date and time when the mass update operation was performed Modified_By: description: The user who performed the mass update operation type: object properties: id: type: string description: User id pattern: ^[0-9]+$ format: int64 name: type: string description: Name displayed for the user who made the modification format: string additionalProperties: false required: - id - name Created_By: description: The user who originally created the record type: object properties: id: type: string description: Numeric string identifier for the creating user pattern: ^[0-9]+$ format: int64 name: type: string description: Name of the user who created the record format: string additionalProperties: false required: - id - name Created_Time: type: string format: date-time description: The date and time when the record was originally created additionalProperties: false required: - id - Modified_Time - Modified_By - Created_By - Created_Time message: type: string description: success message format: string status: type: string description: Indicates the status of the operation enum: - success additionalProperties: false required: - code - details - message - status maxItems: 500 additionalProperties: false required: - data '400': description: Responses for mass update errors content: application/json: schema: oneOf: - type: object description: Returned when the requested module is not supported, such as Services or Appointments modules properties: code: description: Invalid module type: string enum: - INVALID_MODULE message: type: string description: error message format: string status: description: error type: string enum: - error details: type: object description: Invalid module details properties: resource_path_index: type: integer format: int32 description: Index of the unsupported resource path segment additionalProperties: false required: - resource_path_index additionalProperties: false required: - code - message - status - details - type: object description: Responses for mass update errors properties: data: type: array description: List of error responses corresponding to each record that failed during the mass update items: description: Types of errors that can occur during mass update oneOf: - type: object description: A required property is missing from the payload properties: code: description: Mandatory not found type: string enum: - MANDATORY_NOT_FOUND details: description: Mandatory not found type: object properties: {} additionalProperties: false message: type: string description: error message format: string status: description: Mandatory not found type: string enum: - error additionalProperties: false required: - code - details - message - status - type: object description: Returned when the request data is invalid, including parameter validation, field validation, or type mismatches. properties: code: description: Invalid data type: string enum: - INVALID_DATA details: type: object description: Error details for invalid data properties: id: type: string description: Record ID where the validation failed pattern: ^[0-9]+$ format: int64 limit: type: integer format: int32 description: Maximum allowed limit that was exceeded minimum: 1 maximum_length: type: integer format: int32 description: Maximum allowed length for the field value minimum: 1 maximum_decimal_place: type: integer format: int32 description: Maximum allowed decimal places for the field minimum: 0 range: type: object description: Valid range for numeric field values properties: from: type: integer format: int64 description: Minimum allowed value (inclusive) to: type: integer format: int64 description: Maximum allowed value (inclusive) required: - from - to additionalProperties: false additionalProperties: false message: type: string description: error message format: string status: description: Error type: string enum: - error additionalProperties: false required: - code - details - message - status - type: object description: Returned when there is a mapping mismatch between fields, such as a pipeline not containing the specified stage. properties: code: description: Mapping mismatch error type: string enum: - MAPPING_MISMATCH details: type: object description: Error details for mapping mismatch properties: mapped_field: type: string description: The field that has the mapping relationship format: string api_name: type: string description: API name of the field that doesn't match the mapping format: string json_path: type: string description: JSON path to the mismatched element in the request body format: string additionalProperties: false message: type: string description: error message format: string status: description: Error type: string enum: - error additionalProperties: false required: - code - details - message - status - type: object description: Returned when the requested operation or module is not supported. Service and appointment modules are not supported properties: code: description: Invalid module. Services and Appointments type: string enum: - NOT_SUPPORTED - INVALID_MODULE message: type: string description: error message format: string status: description: error type: string enum: - error details: type: object description: Feature not supported additionalProperties: false required: - resource_path_index additionalProperties: false required: - code - message - status - details maxItems: 500 required: - data additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.mass_update.UPDATE - iam-oauth2-schema: - ZohoCRM.mass_update.Leads.UPDATE tags: - Actions get: summary: Retrieve the status of a mass update job description: Retrieves the current status and progress metrics of an asynchronous mass update job initiated via POST /crm/v8/\{module\}/actions/mass_update. Returns record counts and current job state. operationId: getMassUpdateStatus parameters: - $ref: '#/components/parameters/Module_10' - $ref: '#/components/parameters/JobId_3' responses: '200': description: Successfully retrieved the mass update job status, including current state and record processing counts. content: application/json: schema: description: Successfully retrieved the mass update job status, including current state and record processing counts. type: object properties: data: description: Successfully retrieved the mass update job status, including current state and record processing counts. type: array items: description: Contains the mass update job status, including Status, Failed_Count, Updated_Count, Not_Updated_Count, and Total_Count. type: object properties: Status: type: string description: Current state of the mass update job enum: - COMPLETED - SCHEDULED - QUEUED - RUNNING - SUSPENDED - FAILED Failed_Count: type: integer format: int32 description: Number of records that failed to update due to validation or other errors Updated_Count: type: integer format: int32 description: Number of records successfully updated Not_Updated_Count: type: integer format: int32 description: Number of records pending update or skipped Total_Count: type: integer format: int32 description: Total number of records submitted for mass update required: - Failed_Count - Updated_Count - Total_Count - Not_Updated_Count - Status additionalProperties: false maxItems: 1 required: - data additionalProperties: false '400': description: Failed to retrieve mass update job status due to invalid parameters or a missing job content: application/json: schema: oneOf: - type: object description: This response is returned when the required parameter `job_id` is missing properties: code: description: Mandatory not found type: string enum: - MANDATORY_NOT_FOUND details: description: Name of the missing parameter type: object additionalProperties: false message: type: string description: error message format: string status: description: status code type: string enum: - error format: string required: - code - details - message - status additionalProperties: false - type: object description: Invalid job id properties: code: description: Invalid job id type: string enum: - INVALID_DATA details: description: Name of the invalid parameter type: object additionalProperties: false message: type: string description: error message format: string status: description: status code type: string enum: - error required: - code - details - message - status additionalProperties: false - type: object description: Returned when the requested module is not supported, such as the Functions module properties: code: description: Invalid module type: string enum: - INVALID_MODULE message: type: string description: error message format: string status: description: error code type: string enum: - error details: description: resource path index type: object required: - resource_path_index additionalProperties: false required: - code - message - status - details additionalProperties: false security: - iam-oauth2-schema: - ZohoCRM.mass_update.READ - iam-oauth2-schema: - ZohoCRM.mass_update.Leads.READ tags: - Actions /{module}/actions/add_tags: post: summary: POST /{module}/actions/add_tags description: This endpoint is used to associate tags to records operationId: postAddTags parameters: - $ref: '#/components/parameters/ParamQueryModule' - $ref: '#/components/parameters/ParamPathModule' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostaddtagsRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostaddtagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 oneOf: - $ref: '#/components/schemas/ErrorResponseCore2107518198' - $ref: '#/components/schemas/ErrorResponseCore1799630392' - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseCore94581445' - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore356490233' maxItems: 25 required: - tags '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: Error response for status 403 oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.all tags: - Actions /{module}/actions/remove_tags: post: summary: POST /{module}/actions/remove_tags description: This endpoint is used to remove tags from records operationId: postRemoveTags parameters: - $ref: '#/components/parameters/ParamQueryModule1' - $ref: '#/components/parameters/ParamPathModule' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostremovetagsRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostremovetagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 oneOf: - type: object additionalProperties: false description: Wrapped error response with data properties: data: type: array description: Array of error objects items: $ref: '#/components/schemas/ErrorResponseCore2107518198' maxItems: 25 locked_count: maxLength: 10 type: string description: Number of locked records required: - data - $ref: '#/components/schemas/ErrorResponseCore1799630392' - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore356490233' maxItems: 25 required: - tags '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: Error response for status 403 oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.all tags: - Actions /{module}/{id}/actions/add_tags: post: summary: POST /{module}/{id}/actions/add_tags description: This endpoint is used to add tags to record operationId: postAddTagsWithId parameters: - $ref: '#/components/parameters/ParamPathModule' - $ref: '#/components/parameters/ParamPathId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostaddtagsRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostaddtagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 oneOf: - $ref: '#/components/schemas/ErrorResponseCore2107518198' - $ref: '#/components/schemas/ErrorResponseCore1799630392' - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/TagErrorItemResponse' - $ref: '#/components/schemas/ErrorResponseCore833637355' - $ref: '#/components/schemas/MappingMismatchErrorResponse' - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore356490233' maxItems: 25 required: - tags '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: Error response for status 403 oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.all tags: - Actions /{module}/{id}/actions/remove_tags: post: summary: POST /{module}/{id}/actions/remove_tags description: This endpoint is used to dissociate tags from records operationId: postRemoveTagsWithId parameters: - $ref: '#/components/parameters/ParamPathModule' - $ref: '#/components/parameters/ParamPathId' requestBody: description: Request body content: application/json: schema: $ref: '#/components/schemas/PostremovetagsRequest' responses: '200': description: OK - Successful response content: application/json: schema: $ref: '#/components/schemas/PostremovetagsResponse200' '400': description: Bad Request - The request cannot be processed due to invalid syntax. content: application/json: schema: description: Error response for status 400 oneOf: - $ref: '#/components/schemas/ErrorResponseCore2107518198' - $ref: '#/components/schemas/ErrorResponseCore833637355' - $ref: '#/components/schemas/ErrorResponseCore1335454202' - $ref: '#/components/schemas/ErrorResponseCore1273605641' - $ref: '#/components/schemas/ErrorResponseCore1875045219' - $ref: '#/components/schemas/ErrorResponseCore1799630392' - type: object additionalProperties: false description: Wrapped error response with tags properties: tags: type: array description: Array of error objects items: oneOf: - $ref: '#/components/schemas/ErrorResponseCore239878082' - $ref: '#/components/schemas/ErrorResponseCore356490233' maxItems: 25 required: - tags '403': description: Forbidden - The client does not have access rights to the content. content: application/json: schema: description: Error response for status 403 oneOf: - $ref: '#/components/schemas/ErrorResponseCore1161913208' security: - iam-oauth2-schema: - ZohoCRM.settings.tags.all tags: - Actions components: parameters: Module: name: module in: path description: The API name of the module required: true schema: type: string maxLength: 255 JobId: name: job_id in: query description: The unique identifier of the mass change owner job required: true schema: type: string maxLength: 19 Id: name: id in: path description: The unique ID of the record required: true schema: type: string maxLength: 100 description: Record ID ModuleName: name: moduleName in: path description: The API name of the module required: true schema: type: string maxLength: 100 description: Module API name RecordId: name: recordId in: path required: true description: The unique identifier of the parent record for which to count related records. This is typically a numeric ID or UUID depending on the CRM configuration. schema: type: string pattern: ^[0-9a-fA-F-]+$ minLength: 1 maxLength: 50 ModuleApiName: name: moduleApiName in: path required: true description: The API name of the CRM module containing the parent record. Common values include 'Contacts', 'Leads', 'Deals', 'Accounts', 'Services__s', etc. schema: type: string pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 Module_2: name: module description: Specifies the module name in: path required: true schema: type: string maxLength: 100 Record: name: recordID description: This ID is used to uniquely identify a record in: path required: true schema: type: string format: int64 Id_2: name: id in: path required: true description: The ID of the record schema: type: string enum: - '1034369001076415228' - '1034369001076415230' - '1034369001076415231' RecordId_2: name: recordId description: ID of the record in: path required: true schema: type: string maxLength: 20 SharedTo: name: sharedTo description: To specify to whom the record is shared in: query required: false schema: type: string maxLength: 20 ModuleApiName_2: name: moduleApiName description: API name of the module in: path required: true schema: type: string maxLength: 100 View: name: view description: To get the summary of share records in: query required: false schema: type: string enum: - manage - summary Record_2: name: record description: The ID of the record to be updated in: path required: true schema: type: string maxLength: 19 Module_3: name: module in: path required: true schema: type: string enum: - Leads - Accounts - Contacts - Deals - Campaigns - Tasks - Calls - Meetings - Cases - Solutions - Products - Vendors - Price_Books - Quotes - Sales_Orders - Purchase_Orders - Invoices - Custom - Services - Appointments minLength: 1 description: 'Specifies the CRM module for the mass delete operation. Note: Module names are case-sensitive.' Module_4: name: module description: Specifies the module name in: path required: true schema: type: string maxLength: 100 Id_3: name: id description: Unique ID of the source module in: path required: true schema: type: string maxLength: 255 ModuleApiName_3: name: moduleApiName description: Module API of the source module in: path required: true schema: type: string enum: - Quotes - Sales_Orders ParamPathRecordId: name: recordId in: path description: 'Path parameter: recordId' required: true schema: type: string maxLength: 255 ParamPathModuleApiName: name: moduleApiName in: path description: 'Path parameter: moduleApiName' required: true schema: type: string maxLength: 255 Module_5: name: module in: path required: true description: The CRM module name for portal invitation schema: type: string maxLength: 255 RecordId_3: name: recordId in: path required: true description: The unique identifier of the record schema: type: string maxLength: 255 Module_6: name: module in: path required: true description: CRM module name for which records should be merged schema: type: string description: Valid CRM module name enum: - Accounts - Contacts - Leads - Deals - Cases - Campaigns JobId_2: name: job_id in: query required: false description: Optional job ID to track specific merge operation status schema: type: string description: Unique identifier for merge job pattern: ^[0-9]+$ maxLength: 50 MasterRecordId: name: masterRecordId in: path required: true description: Unique identifier of the master record that will be retained after merge schema: type: string description: Master record identifier (int64 as string) pattern: ^[0-9]+$ maxLength: 50 ChannelId: name: channel_id in: query required: false description: Single channel id filter. schema: type: string maxLength: 64 ChannelIds: name: channel_ids in: query required: false description: Comma separated channel ids (delete operations). schema: type: string maxLength: 512 Module_7: name: module in: query required: false description: Module API name filter (e.g. Leads). schema: type: string maxLength: 64 Module_8: name: module in: path description: The module name (e.g., Leads) required: true schema: type: string enum: - Leads Id_4: name: id in: path description: The record ID required: true schema: type: string maxLength: 50 Id_5: name: id in: path required: true description: The unique identifier of the record. Must be a valid numeric record ID. schema: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 20 Ids: name: ids in: query required: true schema: type: string format: int64 description: A single string containing a comma-separated list of valid record IDs. The maximum number of IDs allowed is 200. Fields: name: fields in: query schema: type: string maxLength: 1000 description: A single string containing a comma-separated list of rich text field API names to fetch. ModuleApiName_4: name: moduleApiName in: path required: true description: The module API name of the record (e.g. Leads, Contacts, Deals, Accounts, Services__s, Price_Books) schema: type: string maxLength: 50 Module_9: name: module in: path required: true schema: type: string enum: - Contacts - Leads - Deals - Accounts description: The `schema` field of type `string`. description: Parameter `module` in `path`. Record_3: name: record in: path required: true schema: type: string description: The `schema` field of type `string`. maxLength: 100 description: Parameter `record` in `path`. Module_10: name: module in: path required: true description: 'Specifies the CRM module for the mass update operation. Note: Module names are case-sensitive.' schema: type: string enum: - Leads - Accounts - Contacts - Deals - Campaigns - Tasks - Calls - Meetings - Cases - Solutions - Products - Vendors - Price_Books - Quotes - Sales_Orders - Purchase_Orders - Invoices - Custom JobId_3: name: job_id in: query required: true description: Job identifier for the asynchronous mass update operation initiated via POST. Used to retrieve operation status and result counts. schema: type: string format: int64 pattern: ^[0-9]+$ ParamPathModule: name: module in: path description: 'Path parameter: module' required: true schema: maxLength: 50 type: string ParamQueryModule: name: module in: query description: module api name required: true schema: type: string enum: - module_api_name ParamQueryModule1: name: module in: query description: module api name required: false schema: type: string enum: - module_api_name ParamPathId: name: id in: path description: 'Path parameter: id' required: true schema: maxLength: 19 type: string schemas: FlatErrorResponse: type: object description: Flat error object. additionalProperties: false required: - code - message properties: code: type: string description: Error code maxLength: 100 details: type: object description: Details additionalProperties: true message: type: string description: Message maxLength: 1000 status: type: string description: Status maxLength: 100 SuccessResponse: type: object description: Successful operation response. additionalProperties: false properties: data: type: array description: Results list maxItems: 10 items: type: object description: Status item additionalProperties: false properties: code: type: string description: Code enum: - SUCCESS status: type: string description: Status enum: - success message: type: string description: Message maxLength: 500 details: type: object description: Meta details additionalProperties: false properties: message_id: type: string description: Message ID maxLength: 255 ErrorDetail: type: object description: Individual error item. additionalProperties: false properties: code: type: string description: Code maxLength: 100 details: type: object description: Details additionalProperties: true message: type: string description: Message maxLength: 1000 status: type: string description: Status maxLength: 100 SendMailRequest: type: object description: Root object for the send mail request. additionalProperties: false required: - data properties: data: type: array description: List of mail objects. maxItems: 1 items: type: object description: Detailed email configuration. additionalProperties: false required: - from - to properties: from: $ref: '#/components/schemas/EmailUser' to: type: array description: Primary recipients maxItems: 50 items: $ref: '#/components/schemas/EmailUser' cc: type: array description: CC recipients maxItems: 50 items: $ref: '#/components/schemas/EmailUser' bcc: type: array description: BCC recipients maxItems: 50 items: $ref: '#/components/schemas/EmailUser' reply_to: $ref: '#/components/schemas/EmailUser' subject: type: string description: Email subject maxLength: 1000 content: type: string description: Body content maxLength: 100000 mail_format: type: string description: Format enum: - html - text org_email: type: boolean description: Send via org email scheduled_time: type: string description: ISO8601 time format: date-time consent_email: type: boolean description: GDPR consent flag template: type: object description: Template reference additionalProperties: false properties: id: type: string description: Template ID maxLength: 100 inventory_details: type: object description: Inventory details additionalProperties: false properties: inventory_template: type: object description: Inventory template object additionalProperties: false properties: id: type: string description: ID maxLength: 100 name: type: string description: Name maxLength: 100 paper_type: type: string description: Paper size enum: - default - A4 - us_letter view_type: type: string description: Orientation enum: - portrait - landscape data_subject_request: type: object description: GDPR request details additionalProperties: false properties: id: type: string description: Request ID maxLength: 100 type: type: string description: Request type enum: - access - rectify - export attachments: type: array description: ZFS file IDs maxItems: 10 items: type: object description: File object additionalProperties: false properties: id: type: string description: File ID maxLength: 255 EmailUser: type: object description: User email and name details. additionalProperties: false required: - email properties: user_name: type: string description: Name maxLength: 255 email: type: string description: Email address maxLength: 255 StandardErrorResponse: type: object description: Error data wrapper. additionalProperties: false required: - data properties: data: type: array description: Errors list maxItems: 10 items: $ref: '#/components/schemas/ErrorDetail' FilterField: type: object description: Specifies the field to filter on when counting related records. additionalProperties: false properties: api_name: type: string description: The API name of the field to filter on. pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 required: - api_name RelatedRecordCountItem: type: object description: Specifies a related list to count and optional filtering criteria. additionalProperties: false properties: related_list: $ref: '#/components/schemas/RelatedListReference' params: $ref: '#/components/schemas/CountParameters' required: - related_list ErrorDetails: oneOf: - type: object description: Error details with field information additionalProperties: false properties: api_name: type: string description: The API name of the field that caused the error maxLength: 100 json_path: type: string description: JSON path to the field that caused the error maxLength: 500 required: - api_name - json_path - type: object description: Error details with expected data type information additionalProperties: false properties: expected_data_type: type: string description: The expected data type for the field maxLength: 100 api_name: type: string description: The API name of the field that caused the error maxLength: 100 json_path: type: string description: JSON path to the field that caused the error maxLength: 500 required: - expected_data_type - api_name - json_path - type: object description: Error details with expected fields information additionalProperties: false properties: expected_fields: type: array description: List of expected fields items: type: object description: Expected field information additionalProperties: false properties: api_name: type: string description: The API name of the expected field maxLength: 100 json_path: type: string description: JSON path to the expected field maxLength: 500 required: - api_name - json_path maxItems: 20 required: - expected_fields - type: object description: Error details with parameter name additionalProperties: false properties: param_name: type: string description: The name of the parameter that caused the error maxLength: 255 required: - param_name - type: object description: Error details with supported values additionalProperties: false properties: supported_value: type: array description: List of supported values for the field items: type: string description: A supported value maxLength: 255 maxItems: 20 api_name: type: string description: The API name of the field that caused the error maxLength: 100 json_path: type: string description: JSON path to the field that caused the error maxLength: 500 required: - supported_value - api_name - json_path - type: object description: Error details with maximum length information additionalProperties: false properties: api_name: type: string description: The API name of the field that caused the error maxLength: 100 json_path: type: string description: JSON path to the field that caused the error maxLength: 500 maximum_length: type: integer format: int32 description: The maximum allowed length for the field required: - api_name - json_path - maximum_length RelatedListReference: type: object description: Identifies a specific related list by its API name and unique identifier. additionalProperties: false properties: api_name: type: string description: The API name of the related list (e.g., 'Contacts', 'Deals', 'Tasks'). pattern: ^[A-Za-z0-9_]+$ minLength: 1 maxLength: 100 id: type: string description: The unique identifier of the related list definition. pattern: ^[0-9]+$ minLength: 1 maxLength: 20 required: - api_name - id FilterCriteria: type: object description: Field-based filter criteria to apply before counting records. additionalProperties: false properties: comparator: type: string description: The comparison operator to use for filtering. enum: - equal field: $ref: '#/components/schemas/FilterField' value: type: string description: The value to compare the field against. minLength: 1 maxLength: 255 required: - comparator - field - value ErrorResponse: type: object description: Error response structure additionalProperties: false properties: status: type: string description: The status of the response enum: - error code: type: string description: The error code enum: - INVALID_DATA - PATTERN_NOT_MATCHED - MANDATORY_NOT_FOUND - EXPECTED_FIELD_MISSING - NOT_SUPPORTED - DEPENDENT_FIELD_MISMATCH message: type: string description: The error message maxLength: 1000 details: $ref: '#/components/schemas/ErrorDetails' required: - status - code - message - details RelatedRecordCountResult: type: object description: The count result for a specific related list. additionalProperties: false properties: count: type: integer format: int32 description: The total number of related records matching the specified criteria. minimum: 0 related_list: $ref: '#/components/schemas/RelatedListReference' required: - count - related_list CountParameters: type: object description: Optional filtering and selection parameters to apply before counting records. additionalProperties: false properties: approved: type: boolean description: Filter to include only approved records when counting. filters: $ref: '#/components/schemas/FilterCriteria' converted: type: boolean description: Filter to include only converted records when counting (applicable to Leads). category: type: string description: Filter by record category type. enum: - link - files approval_state: type: string description: Filter by approval workflow state. enum: - approved required: - filters GetRelatedRecordsCountResponse: type: object description: Successful response containing count results for the requested related lists. additionalProperties: false properties: get_related_records_count: type: array description: Array of count result arrays, one entry per requested related list. items: type: array description: Wrapper array containing count result objects. items: $ref: '#/components/schemas/RelatedRecordCountResult' maxItems: 2147483647 x-actual-limit: unlimited maxItems: 20 required: - get_related_records_count GetRelatedRecordsCountRequest: type: object description: Request payload containing an array of related list count specifications. additionalProperties: false properties: get_related_records_count: type: array description: Array of related list count requests. Each item specifies a related list and optional filtering criteria. items: $ref: '#/components/schemas/RelatedRecordCountItem' minItems: 1 maxItems: 20 required: - get_related_records_count RecordUnathorizedResponse: description: Response schema returned when a request is unauthorized due to OAuth scope mismatches. type: object additionalProperties: false properties: data: type: array maxItems: 100 description: List of error objects indicating that the request is not authorized. items: type: object description: Error object representing an OAuth scope mismatch. additionalProperties: false properties: code: type: string description: Machine-readable error code indicating an OAuth scope mismatch. enum: - OAUTH_SCOPE_MISMATCH message: type: string maxLength: 1024 description: Human-readable explanation describing why the OAuth token is unauthorized. status: type: string description: Overall execution status of the request. enum: - error required: - code - message - status RecordInvalidURLResponse: description: Response schema returned when the requested API endpoint URL pattern is invalid or unsupported. type: object additionalProperties: false properties: data: type: array maxItems: 100 description: List of error objects indicating an invalid or unsupported API endpoint URL. items: type: object description: Error object representing an invalid API URL pattern. additionalProperties: false properties: code: type: string description: Machine-readable error code indicating an invalid endpoint URL pattern. enum: - INVALID_URL_PATTERN message: type: string maxLength: 1024 description: Human-readable explanation describing why the requested URL is invalid. status: type: string description: Overall execution status of the request. enum: - error required: - code - message - status RecordSuccessResponse: description: Standard success response schema for single or bulk record operations. type: object additionalProperties: false properties: data: type: array maxItems: 100 description: List of successfully processed records with detailed metadata. items: type: object description: Success object representing a single successfully processed record. additionalProperties: false properties: code: type: string description: Machine-readable code indicating a successful operation. enum: - SUCCESS message: type: string maxLength: 1024 description: Human-readable success message describing the operation outcome. status: type: string description: Overall execution status of the operation. enum: - success details: type: object description: Detailed metadata about the processed record. additionalProperties: true properties: id: type: string format: int64 description: Unique identifier of the record. Modified_Time: type: string format: date-time description: Timestamp indicating when the record was last modified. Created_Time: type: string format: date-time description: Timestamp indicating when the record was created. Created_By: type: object description: User who originally created the record. additionalProperties: false properties: name: type: string maxLength: 100 description: Display name of the creating user. id: type: string format: int64 description: Unique identifier of the creating user. required: - name - id Modified_By: type: object description: User who last modified the record. additionalProperties: false properties: name: type: string maxLength: 100 description: Display name of the modifying user. id: type: string format: int64 description: Unique identifier of the modifying user. required: - name - id $approval_state: type: string maxLength: 1024 description: Approval state of the record in the approval workflow. required: - id - Modified_Time - Created_Time - Created_By - Modified_By - $approval_state required: - code - message - status - details required: - data RecordsInputSchema: description: Input schema for create, update, or upsert record requests. type: object additionalProperties: false required: - data properties: data: type: array maxItems: 100 description: Request body containing one or more records to be created or updated. items: type: object description: Payload representing a single record to be created or updated. additionalProperties: true properties: id: type: string maxLength: 1024 description: Unique identifier of the record. Required when modifying an existing record. $append_values: type: string maxLength: 1024 description: Controls whether values in a multi-select picklist field should be appended or replaced during an update operation. apply_feature_execution: type: array maxItems: 100 description: List of features that should be executed on demand during record processing. items: type: object description: Feature execution configuration object. additionalProperties: true skip_feature_execution: type: array maxItems: 100 description: List of features that should be skipped during record processing. items: type: object description: Feature skip configuration object. additionalProperties: true trigger: type: array maxItems: 100 description: List of automation triggers to invoke during the record operation. items: type: string description: Type of automation trigger to be executed. enum: - approval - workflow - blueprint - pathfinder - orchestration RecordInternalErrorResponse: description: Schema for internal server error responses related to record operations. type: object additionalProperties: false properties: data: type: array maxItems: 100 description: List of error objects describing internal server failures. items: type: object description: Error object representing an unexpected internal server error. additionalProperties: false properties: code: type: string description: Machine-readable error code indicating an internal server failure. enum: - INTERNAL_ERROR message: type: string maxLength: 1024 description: Human-readable description of the internal server error. status: type: string description: Overall execution status of the request. enum: - error required: - code - message - status RecordPermissionResponse: description: Response schema returned when a user lacks the necessary permissions to perform a record operation. type: object additionalProperties: false properties: data: type: array maxItems: 100 description: List of error objects indicating insufficient user permissions. items: type: object description: Error object representing a permission denial. additionalProperties: false properties: code: type: string description: Machine-readable error code indicating the user does not have permission. enum: - NO_PERMISSION message: type: string maxLength: 1024 description: Human-readable explanation describing the permission denial. status: type: string description: Overall execution status of the request. enum: - error required: - code - message - status RecordsErrorResponse: description: Standard error response schema returned when one or more record operations fail. type: object additionalProperties: false properties: data: type: array maxItems: 100 description: List of error objects describing individual record-level failures. items: type: object description: Error object representing a failure encountered while processing a record. additionalProperties: false properties: code: type: string description: Machine-readable error code identifying the reason for the failure. enum: - INVALID_DATA - INVALID_MODULE - MULTIPLE_OR_MULTI_ERRORS - DEPENDENT_FIELD_MISSING - DEPENDENT_SERVICE_ERROR - MANDATORY_NOT_FOUND - DEPENDENT_MISMATCH - INVALID_REQUEST_METHOD - AUTHORIZATION_FAILED - DUPLICATE_DATA - LIMIT_EXCEEDED - RECORD_LOCKED - EXPECTED_FIELD_MISSING details: type: object additionalProperties: true description: Additional details associated with the error. properties: resource_path_index: type: integer format: int32 description: Position of the record in the request payload where the error occurred. api_name: type: string maxLength: 1024 description: The API name of the field associated with the error. json_path: type: string maxLength: 1024 description: JSONPath pointer to the field that caused the error. expected_fields: type: array maxItems: 100 description: Used specifically when the error code is EXPECTED_FIELD_MISSING. items: type: object additionalProperties: false description: Additional information on the missing fields required: - api_name - json_path properties: api_name: maxLength: 1024 type: string description: Name of the missing expected field. json_path: maxLength: 1024 type: string description: JSONPath location of the expected field. message: type: string maxLength: 1024 description: Human-readable explanation of the error. status: type: string description: Indicates the outcome of the operation for the record. enum: - error required: - code - message - status SchedularAlreadyRunningErrorResponse: description: Schedular Already Running Error Response - POST and PUT API type: object properties: code: type: string description: response code enum: - CANNOT_PROCESS details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - Scheduler is running status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status InvalidTypeErrorResponse: description: Invalid Type Error Response - GET API type: object properties: share: type: array description: list of share record retrieval error responses maxItems: 20 items: type: object description: share record retrieval error response details properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information properties: api_name: type: string description: name of the parameter which caused the error enum: - type - permission json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 regex: type: string description: regex pattern that was expected enum: - private|public - read_only|read_write|full_access additionalProperties: false required: - api_name - json_path - regex message: type: string description: response message enum: - invalid data status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status required: - share additionalProperties: false SharingSharedRecordErrorResponse: description: Sharing Shared Record Error Response - POST and PUT API type: object properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - Shared record cannot be shared to other users status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status NotifyMembersWithoutFeeds: description: Notify Members Without Feeds - POST and PUT API type: object properties: code: type: string description: response code enum: - NOT_ALLOWED details: type: object description: additional information properties: api_name: type: string description: API name related to the share record limit enum: - notify_shared_members json_path: type: string description: JSON path of the parameter which caused the error enum: - $.notify_shared_members additionalProperties: false message: type: string description: response message enum: - Feeds is not enabled for this org - Feeds Notification is not allowed for this type status: type: string description: response status enum: - error required: - code - details - message - status additionalProperties: false InvalidShareWithValueErrorResponse: description: Invalid Share With Value Error Response - POST and PUT API type: object properties: share: type: array description: list of share record creation error responses maxItems: 20 items: type: object description: share record creation error response details properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information additionalProperties: false properties: api_name: type: string description: name of the parameter which caused the error maxLength: 50 json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 dependee: type: object description: details of the dependent parameter properties: api_name: type: string description: name of the dependent parameter maxLength: 50 json_path: type: string description: JSON path of the dependent parameter maxLength: 100 additionalProperties: false required: - api_name - json_path required: - api_name - json_path - dependee message: type: string description: response message enum: - invalid data status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status additionalProperties: false required: - share UnsupportedModule: description: Invalid Module - POST and PUT API type: object properties: code: type: string description: response code enum: - NOT_ALLOWED details: type: object description: additional information properties: resource_path_index: type: integer description: API name related to the share record limit format: int32 additionalProperties: false message: type: string description: response message maxLength: 200 status: type: string description: response status enum: - error required: - code - details - message - status additionalProperties: false RecordForbiddenErrorResponse: description: Record Forbidden Error Response type: object properties: code: type: string description: response code enum: - NO_PERMISSION details: type: object description: additional information properties: permissions: type: array description: list of permissions that are missing maxItems: 1 items: type: string description: permission which is missing maxLength: 200 additionalProperties: false required: - permissions message: type: string description: response message enum: - permission denied status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status MandatoryNotFound: description: Mandatory Not Found Error Response - POST and PUT API type: object properties: share: type: array description: list of share record creation error responses maxItems: 20 items: type: object description: share record creation error response details properties: code: type: string description: response code enum: - MANDATORY_NOT_FOUND details: type: object description: additional information additionalProperties: false properties: api_name: type: string description: name of the parameter which caused the error maxLength: 50 json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 required: - api_name - json_path message: type: string description: response message enum: - required field not found status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status additionalProperties: false ActivityModuleRelatedIssueErrorResponse: description: Activity Module Related Issue Error Response - POST and PUT API type: object properties: share: type: array description: list of share record creation error responses maxItems: 20 items: type: object description: share record creation error response details properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information additionalProperties: false properties: api_name: type: string description: name of the parameter which caused the error maxLength: 50 json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 required: - api_name - json_path message: type: string description: response message enum: - cannot share the related records status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status additionalProperties: false required: - share NoSharingAvailableToRevokeErrorResponse: description: No Sharing Available To Revoke Error Response - DELETE API type: object properties: code: type: string description: response code enum: - CANNOT_PROCESS details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - No sharing through this record is available to revoke status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status AmbiguousShareErrorResponse: description: Ambiguous Share Error Response - POST and PUT API type: object properties: code: type: string description: response code enum: - AMBIGUITY_DURING_PROCESSING details: type: object description: additional information properties: ambiguity_due_to: type: array description: list of reasons for ambiguity items: type: object description: reason for ambiguity properties: api_name: type: string description: API name related to the share record limit maxLength: 100 json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 additionalProperties: false maxItems: 20 additionalProperties: false message: type: string description: response message enum: - For public sharing more than one json object is given status: type: string description: response status enum: - error additionalProperties: false RecordLevelSharingNotSupportedForModuleErrorResponse: description: Record Level Sharing Not Supported For Module Error Response - POST and PUT API type: object properties: code: type: string description: response code enum: - NOT_ALLOWED details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - Record Level Sharing is not supported for this module status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status ShareLimitExceedErrorResponse: description: Share Limit Exceed Error Response - POST and PUT API type: object properties: share: type: array description: list of share record creation error responses maxItems: 20 items: type: object description: share record creation error response details properties: code: type: string description: response code enum: - LIMIT_EXCEEDED details: type: object description: additional information properties: limit: type: integer description: maximum number of share records allowed format: int32 api_name: type: string description: API name related to the share record limit enum: - type json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 additionalProperties: false message: type: string description: response message maxLength: 100 status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status additionalProperties: false required: - share InvalidRecordIdErrorResponse: description: Invalid Record Id Error Response - GET, DELETE API type: object properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information properties: resource_path_index: type: integer description: index of the resource path which caused the error format: int32 default: 1 additionalProperties: false required: - resource_path_index message: type: string description: response message enum: - ENTITY_ID_INVALID status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status InvalidShareWithIdErrorResponse: description: Invalid Share With User Id Error Response - POST and PUT API type: object properties: share: type: array description: list of share record creation error responses maxItems: 20 items: type: object description: share record creation error response details properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information additionalProperties: false properties: api_name: type: string description: name of the parameter which caused the error maxLength: 50 json_path: type: string description: JSON path of the parameter which caused the error maxLength: 100 required: - api_name - json_path message: type: string description: response message enum: - invalid data - invalid user Id - invalid role Id - invalid group Id - cannot share to the user status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status additionalProperties: false required: - share InvalidModuleNameErrorResponse: description: Invalid Module Name Error Response - GET, DELETE API type: object properties: code: type: string description: response code enum: - INVALID_MODULE details: type: object description: additional information properties: resource_path_index: type: integer description: index of the resource path which caused the error format: int32 default: 0 additionalProperties: false required: - resource_path_index message: type: string description: response message enum: - the module name given seems to be invalid status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status CommonForbiddenErrorResponse: description: Common Forbidden Error Response type: object properties: code: type: string description: response code enum: - NO_PERMISSION details: type: object description: additional information additionalProperties: false message: type: string description: response message enum: - permission denied - access the api - permission denied status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status MaximumLengthErrorResponse: description: Maximum Length Error Response - POST and PUT API type: object properties: code: type: string description: response code enum: - INVALID_DATA details: type: object description: additional information properties: api_name: type: string description: name of the parameter which caused the error enum: - share json_path: type: string description: JSON path of the parameter which caused the error enum: - $.share maximum_length: type: integer description: maximum allowed length format: int32 additionalProperties: false required: - api_name - json_path - maximum_length message: type: string description: response message enum: - invalid data status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status ViewParamWithManageValueErrorResponse: description: View Param With Manage Value Error Response - GET API type: object properties: code: type: string description: response code enum: - PATTERN_NOT_MATCHED details: type: object description: additional information properties: api_name: type: string description: name of the parameter which caused the error(view) enum: - view additionalProperties: false required: - api_name message: type: string description: response message enum: - Please check whether the input values are correct status: type: string description: response status enum: - error additionalProperties: false required: - code - details - message - status EmailAddress: type: object description: Object representing an email address and display name. additionalProperties: false properties: user_name: type: string description: The display name of the user. maxLength: 255 email: type: string format: email description: The actual email address string. maxLength: 255 required: - email AttachmentRef: type: object description: Reference to an email attachment. additionalProperties: false properties: id: type: string description: The attachment ID. maxLength: 100 required: - id AssociateEmailRequest: type: object description: Request body for associating an email with a record. additionalProperties: false properties: data: type: array description: List of email objects to process. items: $ref: '#/components/schemas/EmailObject' minItems: 1 maxItems: 50 required: - data ActionResponse: type: object description: Generic wrapper for multiple record action responses. additionalProperties: false properties: data: type: array description: Array of result statuses. maxItems: 50 items: type: object description: Individual result for a specific record. additionalProperties: false properties: code: type: string description: Status code. maxLength: 50 details: type: object description: Contextual details. additionalProperties: false message: type: string description: Result message. maxLength: 255 status: type: string description: Operation status. maxLength: 50 ErrorResponse_2: type: object description: Details about a failed API request. additionalProperties: false properties: code: type: string description: Error code. maxLength: 50 message: type: string description: Error message. maxLength: 255 status: type: string description: Error status. maxLength: 50 details: type: object description: Detailed error context. additionalProperties: false EmailObject: type: object description: Detailed email metadata object. additionalProperties: false properties: from: $ref: '#/components/schemas/EmailAddress' to: type: array description: Primary recipients. maxItems: 50 items: $ref: '#/components/schemas/EmailAddress' cc: type: array description: Carbon copy recipients. maxItems: 50 items: $ref: '#/components/schemas/EmailAddress' bcc: type: array description: Blind carbon copy recipients. maxItems: 50 items: $ref: '#/components/schemas/EmailAddress' subject: type: string description: The subject of the email. maxLength: 500 content: type: string description: The email body content. maxLength: 32000 mail_format: type: string description: Email content format. enum: - text - html default: text original_message_id: type: string description: Unique identifier from the mail server. maxLength: 255 sent: type: boolean description: Whether the email was sent or received. date_time: type: string format: date-time description: Timestamp of the email. maxLength: 50 attachments: type: array description: List of associated attachments. maxItems: 20 items: $ref: '#/components/schemas/AttachmentRef' required: - from - to - subject - content - original_message_id - sent - date_time ErrorResponseCore1362235056: type: object additionalProperties: false description: 'Invalid data type for field: ids' properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: limit: type: integer format: int32 description: 'Detail field: limit' limit_due_to: type: array description: 'Detail field: limit_due_to' items: type: object additionalProperties: false description: 'Detail Field: limit_due_to' 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 maxItems: 25 required: - limit - limit_due_to message: type: string description: Error message enum: - Limit Exceeded, You cannot give more than 100 record ids status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core DetailsNested: type: object additionalProperties: false description: Nested schema for details properties: cadences: type: array description: 'Field: cadences' items: $ref: '#/components/schemas/CadencesNested' maxItems: 2 id: type: string description: 'Field: id' maxLength: 255 ErrorResponseCore1137512454: type: object additionalProperties: false description: 'Invalid data type for field: cadences_ids' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' 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 - json_path - maximum_length 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 ErrorResponseCore814179042: type: object additionalProperties: false description: 'Invalid data type for field: cadences_ids' properties: code: type: string description: Error code enum: - LIMIT_EXCEEDED details: type: object additionalProperties: false description: Error details with validation information properties: limit: type: integer format: int32 description: 'Detail field: limit' limit_due_to: type: array description: 'Detail field: limit_due_to' items: type: object additionalProperties: false description: 'Detail Field: limit_due_to' 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 maxItems: 25 required: - limit - limit_due_to message: type: string description: Error message enum: - Limit Exceeded, You cannot give more than 5 cadence ids status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core CadencesNested: type: object additionalProperties: false description: Nested schema for cadences properties: name: type: string description: 'Field: name' maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 ErrorDataNested: type: object additionalProperties: false description: Nested schema for data properties: code: type: string description: Respone code enum: - INVALID_DATA maxLength: 255 details: type: object description: details schema for error case additionalProperties: true properties: api_name: type: string description: api_name of error details maxLength: 255 enum: - ids json_path: type: string description: json_path of error details maxLength: 255 message: type: string description: error message maxLength: 255 status: type: string description: status of the request enum: - error maxLength: 255 ErrorResponse403: type: object additionalProperties: false description: No permission to access this resource properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 message: type: string description: Error message enum: - No permission status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response 403 PostcadencesResponse200: type: object additionalProperties: false description: Successful API operation completed properties: data: type: array description: root element json items: $ref: '#/components/schemas/SuccessDataNested' maxItems: 1 PostcadencesResponse207: type: object additionalProperties: false description: Multi status response for unenrolment properties: data: type: array description: 'Field: data' items: anyOf: - $ref: '#/components/schemas/SuccessDataNested' - $ref: '#/components/schemas/ErrorDataNested' maxItems: 100 PostCadencesRequest: type: object additionalProperties: false description: Request body schema properties: cadences_ids: type: array description: Cadence ids has to be given here (Required) items: type: string description: cadence id maxLength: 255 maxItems: 5 ids: type: array description: records ids to be enroll (Required) items: type: string description: record id maxLength: 255 maxItems: 100 required: - cadences_ids - ids ErrorResponseCore1414382895: type: object additionalProperties: false description: id given is not manual enrollment cadence properties: code: type: string description: Error code enum: - NOT_ALLOWED details: type: object additionalProperties: false description: Error details with validation information properties: 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 - json_path message: type: string description: Error message enum: - id given is not manual enrollment cadence status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore260315750: type: object additionalProperties: false description: API not supported for client portal users properties: code: type: string description: Error code enum: - API_NOT_SUPPORTED details: type: object additionalProperties: false description: Error details with validation information properties: unsupported_login_user_type: type: string description: 'Detail field: unsupported_login_user_type' maxLength: 255 required: - unsupported_login_user_type message: type: string description: Error message enum: - api not supported for client portal user status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core SuccessDataNested: type: object additionalProperties: false description: Nested schema for data properties: code: type: string description: success code maxLength: 255 details: $ref: '#/components/schemas/DetailsNested' message: type: string description: Success message maxLength: 255 status: type: string description: response status maxLength: 255 ErrorResponseCore1243473672: type: object additionalProperties: false description: API not supported for selected domains properties: code: type: string description: Error code enum: - API_NOT_SUPPORTED details: type: object additionalProperties: false description: Error details with validation information properties: supported_domains: type: array description: 'Detail field: supported_domains' items: type: string description: 'Detail Field: supported_domains' maxLength: 255 maxItems: 25 required: - supported_domains message: type: string description: Error message enum: - api not supported status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core SendMailMergeNested: type: object additionalProperties: false description: Request payload for sending mail merge emails. properties: bcc_email: type: array description: The details of the email or the mail merge field you want to include in the email's bcc. The keys are same as the ones in the "from_address" JSON object. items: $ref: '#/components/schemas/BccEmailNested' maxItems: 1 mail_merge_template: $ref: '#/components/schemas/MailMergeTemplateNested' description: Mailmerge Object to pass Template details (Required) subject: type: string description: The subject line of the email. maxLength: 255 cc_email: type: array description: The details of the email or the mail merge field you want to include in the email's cc. The keys are same as the ones in the "from_address" JSON object. items: $ref: '#/components/schemas/CcEmailNested' maxItems: 1 attachment_name: type: string description: The name of the attachment you want to include in the email. maxLength: 255 to_address: type: array description: The email ID you want to use to send emails to. items: $ref: '#/components/schemas/ToAddressNested' maxItems: 2 type: type: string description: The attachment type you want to include in the email. The possible values are inline to send the attachment as an inline image, and attachment to send the the file separately. enum: - inline - attachment maxLength: 10 message: type: string description: Represents the body or content of the email you want to send. It can include up to 100,000 characters. maxLength: 100000 from_address: $ref: '#/components/schemas/FromAddressNested' description: The email ID you want to use to send emails from. This email address must be the one of the org-verified email addresses or the current user's email ID. required: - mail_merge_template DetailsNested1: type: object additionalProperties: false description: Response details for sign mail merge operation. properties: sign_resource_id: type: string description: Unique identifier for the signature request resource maxLength: 255 report_link: type: string description: URL link to the signature report format: uri maxLength: 255 PostsignmailmergeResponse200: type: object additionalProperties: false description: Upon successful initiation of sign mail merge the response as follows. properties: sign_mail_merge: type: array description: 'Field: sign_mail_merge' items: $ref: '#/components/schemas/SignMailMergeNested1' maxItems: 1 SignMailMergeNested1: type: object additionalProperties: false description: Response payload for sign mail merge operation. properties: code: type: string description: Response code indicating the result of the operation maxLength: 255 details: $ref: '#/components/schemas/DetailsNested1' message: type: string description: Human-readable message describing the result maxLength: 255 status: type: string description: Status of the operation enum: - success - error maxLength: 255 InvalidModulePathError: type: object additionalProperties: false description: Error when the module given in the URL path is invalid properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: Index of the resource path segment containing the invalid module required: - resource_path_index message: type: string description: Error message enum: - module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Module Path Error RequiredParamMissingError: type: object additionalProperties: false description: Error when a mandatory parameter is not given properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: Name of the missing required parameter maxLength: 255 required: - param_name message: type: string description: Error message enum: - mandatory param missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Required Param Missing Error InvalidRequestMethodError: type: object additionalProperties: false description: Error when the HTTP request method is not supported for the URL properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - The http request method type is not a valid one status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Request Method Error MailMergeTemplateNested: type: object additionalProperties: false description: Mailmerge Object to pass Template details properties: name: type: string description: The name of the mail merge template you want to use. maxLength: 255 required: - name FromAddressNested: type: object additionalProperties: false description: The email ID you want to use to send emails from. This email address must be the one of the org-verified email addresses or the current user's email ID. properties: type: type: string description: Type of the address. Must be 'email'. enum: - email maxLength: 5 value: type: string format: email description: The email ID you want to use to send emails from. pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ maxLength: 255 required: - type - value SignMailMergeNested: type: object additionalProperties: false description: Request payload for sending documents for signature. properties: sign_in_order: type: boolean description: The value true indicates that the document will first be sent for approval and then for signing. signers: type: array description: The details of the users you want to sign the document. items: $ref: '#/components/schemas/SignersNested' maxItems: 3 mail_merge_template: $ref: '#/components/schemas/MailMergeTemplateNested' description: To pass Template details (Required) file_name: type: string description: The name of the file you want to send for signing and approval. maxLength: 255 required: - file_name - mail_merge_template ExpectedFieldMissingError: type: object additionalProperties: false description: Error when at least one expected field is missing properties: code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: expected_fields: type: array description: List of expected fields, at least one of which must be provided items: type: object additionalProperties: false description: Expected field information properties: api_name: type: string description: Name of the expected field maxLength: 255 json_path: type: string description: JSON path to the expected field maxLength: 1000 required: - api_name - json_path maxItems: 25 required: - expected_fields message: type: string description: Error message enum: - specify atleast one field status: type: string description: Error status enum: - error required: - code - details - message - status title: Expected Field Missing Error PostsendmailmergeRequest: type: object additionalProperties: false description: Request body schema for send mail merge operation. properties: send_mail_merge: type: array description: Root Element (Required) items: $ref: '#/components/schemas/SendMailMergeNested' maxItems: 1 required: - send_mail_merge InvalidModuleParamError: type: object additionalProperties: false description: Error when the module given in the parameter is invalid properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: Name of the parameter containing the invalid module maxLength: 255 required: - param_name message: type: string description: Error message enum: - module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Module Param Error ExpectedParamMissingError: type: object additionalProperties: false description: Error when one of the expected parameters is missing to process the request properties: code: type: string description: Error code enum: - EXPECTED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_names: type: array description: List of expected parameter names, at least one of which must be provided items: type: string description: Expected parameter name maxLength: 255 maxItems: 25 required: - param_names message: type: string description: Error message enum: - One of the expected parameter is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Expected Param Missing Error InvalidDataTypeError: type: object additionalProperties: false description: Error when the data type provided is invalid 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: The data type that was expected maxLength: 255 api_name: type: string description: Name of the API field that failed validation maxLength: 255 json_path: type: string description: JSON path to the field that failed validation maxLength: 1000 required: - api_name - expected_data_type - json_path message: type: string description: Error message enum: - Invalid data type status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Type Error CcEmailNested: type: object additionalProperties: false description: The details of the email or the mail merge field you want to include in the email's cc. The keys are same as the ones in the "from_address" JSON object. properties: type: type: string description: Type of the address. Must be 'email'. enum: - email maxLength: 5 value: type: string format: email description: The email IDs you want to use to send emails to. pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ maxLength: 255 required: - type - value InvalidDataParamError: type: object additionalProperties: false description: Error when invalid data is sent in a parameter properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: Name of the parameter containing invalid data maxLength: 255 required: - param_name message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Param Error PostsignmailmergeRequest: type: object additionalProperties: false description: Request body schema for sign mail merge operation. properties: sign_mail_merge: type: array description: Root element key (Required) items: $ref: '#/components/schemas/SignMailMergeNested' maxItems: 1 required: - sign_mail_merge PostdownloadmailmergeRequest: type: object additionalProperties: false description: Request body schema for download mail merge operation. properties: download_mail_merge: type: array description: Root Element (Required) items: $ref: '#/components/schemas/DownloadMailMergeNested' maxItems: 1 required: - download_mail_merge RecipientNested: type: object additionalProperties: false description: Recipient details for signature or approval properties: type: type: string description: Type of recipient identifier. Use 'email' for direct email addresses or 'merge_field' for mail merge field references. enum: - email - merge_field maxLength: 11 value: type: string description: The email ID of the user or a merge field reference (e.g., ${!Leads.Email}) who has to sign or approve the document. maxLength: 255 required: - type - value DetailsNested_2: type: object additionalProperties: false description: Response details for send mail merge operation. properties: report_link: type: string description: URL link to the mail merge report format: uri maxLength: 255 MandatoryFieldNotFoundBodyError: type: object additionalProperties: false description: Error when a required field is not found in the request body properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: Name of the missing mandatory field maxLength: 255 json_path: type: string description: JSON path to the missing mandatory field maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - required field not found status: type: string description: Error status enum: - error required: - code - details - message - status title: Mandatory Field Not Found Body Error BccEmailNested: type: object additionalProperties: false description: The details of the email or the mail merge field you want to include in the email's bcc. The keys are same as the ones in the "from_address" JSON object. properties: type: type: string description: Type of the address. Must be 'email'. enum: - email maxLength: 5 value: type: string format: email description: The email ID you want to use to send emails to. pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ maxLength: 255 required: - type - value MandatoryFieldNotFoundError: type: object additionalProperties: false description: Error when a required field is missing properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND details: type: object additionalProperties: false description: Error details with validation information properties: api_name: type: string description: Name of the missing mandatory field maxLength: 255 json_path: type: string description: JSON path to the missing mandatory field maxLength: 1000 required: - api_name - json_path message: type: string description: Error message enum: - Required field is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Mandatory Field Not Found Error ToAddressNested: type: object additionalProperties: false description: The email ID you want to use to send emails to. properties: type: type: string description: Type of the address. Must be 'email'. enum: - email maxLength: 5 value: type: string format: email description: The email ID you want to use to send emails to. pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ maxLength: 255 required: - type - value InvalidDataMaxLengthError: type: object additionalProperties: false description: Error when data exceeds maximum allowed length properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: Maximum allowed length for the field api_name: type: string description: Name of the API field that failed validation maxLength: 255 json_path: type: string description: JSON path to the field that failed validation maxLength: 1000 required: - api_name - json_path - maximum_length message: type: string description: Error message enum: - Invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data Max Length Error SignersNested: type: object additionalProperties: false description: The details of the users you want to sign the document. properties: recipient: $ref: '#/components/schemas/RecipientNested' description: Recipient Object (Required) recipient_name: type: string description: The name of the user who has to sign or approve the document. maxLength: 255 action_type: type: string description: The type of action you want the user to perform. The possible values are sign to sign the document, and approve to approve the document. enum: - sign - approve maxLength: 7 required: - action_type - recipient - recipient_name InvalidDataUrlError: type: object additionalProperties: false description: Error when invalid data is sent in the URL properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: resource_path_index: type: integer format: int32 description: Index of the resource path segment that contains invalid data required: - resource_path_index message: type: string description: Error message enum: - invalid data status: type: string description: Error status enum: - error required: - code - details - message - status title: Invalid Data URL Error PostsendmailmergeResponse200: type: object additionalProperties: false description: Upon successful initiation of send mail merge the response as follows. properties: send_mail_merge: type: array description: 'Field: send_mail_merge' items: $ref: '#/components/schemas/SendMailMergeNested1' maxItems: 1 SendMailMergeNested1: type: object additionalProperties: false description: Response payload for send mail merge operation. properties: code: type: string description: Response code indicating the result of the operation maxLength: 255 details: $ref: '#/components/schemas/DetailsNested_2' message: type: string description: Human-readable message describing the result maxLength: 255 status: type: string description: Status of the operation enum: - success - error maxLength: 255 DownloadMailMergeNested: type: object additionalProperties: false description: Request payload for downloading mail merge documents. properties: mail_merge_template: $ref: '#/components/schemas/MailMergeTemplateNested' description: To pass template name (Required) output_format: type: string description: The format you want for the document. This can be pdf, html or docx. The default format will be pdf. enum: - pdf - html - docx maxLength: 4 file_name: type: string description: The file name you want for the document. Default value will be "download". Maximum size for file_name is 255 characters. maxLength: 255 required: - mail_merge_template ErrorDetails_2: type: object description: Specific details about the error, often including which parameter or value caused the issue. additionalProperties: false properties: api_name: type: string description: The API name of the parameter or field related to the error. maxLength: 64 expected_data_type: type: string description: The expected data type for a parameter or field. maxLength: 64 json_path: type: string description: The JSON path indicating the location of the error in the request payload. maxLength: 256 ambiguity_due_to: maxItems: 2 type: array description: List of fields causing ambiguity during processing. items: type: object description: Ambiguity field details. additionalProperties: false properties: api_name: type: string description: The API name of the ambiguous field. maxLength: 64 json_path: type: string description: The JSON path indicating the location of the ambiguous field. maxLength: 256 required: - api_name - json_path expected_fields: maxItems: 2 type: array description: List of expected fields when multiple fields are required. items: type: object description: Expected field details. additionalProperties: false properties: api_name: type: string description: The API name of the expected field. maxLength: 64 json_path: type: string description: The JSON path indicating the location of the expected field. maxLength: 256 required: - api_name - json_path dependee: type: object description: Details of the dependee field that is missing. additionalProperties: false properties: api_name: type: string description: The API name of the dependee field. maxLength: 64 json_path: type: string description: The JSON path indicating the location of the dependee field. maxLength: 256 required: - api_name - json_path supported_values: type: array description: List of supported values for a parameter or field. maxItems: 2 items: type: string description: A supported value. maxLength: 64 maximum_length: type: integer format: int32 description: The maximum allowed length for a parameter or field. ErrorResponse_3: type: object description: Standard error response structure containing error code, message, and optional details additionalProperties: false properties: code: type: string description: The specific error code. enum: - INVALID_DATA - INVALID_QUERY - NOT_SUBSCRIBED - EXPECTED_PARAM_MISSING - LIMIT_REACHED - NOT_SUPPORTED - INVALID_REQUEST_METHOD - AUTHORIZATION_FAILED - OAUTH_SCOPE_MISMATCH - NO_PERMISSION - INVALID_URL_PATTERN - INTERNAL_ERROR - RATE_LIMIT_EXCEEDED - SERVICE_UNAVAILABLE - INVALID_MODULE - MANDATORY_NOT_FOUND - EXPECTED_FIELD_MISSING - AMBIGUITY_DURING_PROCESSING - DEPENDENT_FIELD_MISSING details: $ref: '#/components/schemas/ErrorDetails_2' message: type: string description: A human-readable error message. maxLength: 1000 status: type: string description: Status indicator for the response, always 'error' for error responses enum: - error default: error required: - code - message - status TerritoryAssignInvalidDataOnURL: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: resource_path_index: format: int32 type: integer description: Index in the resource path where the error occurred. required: - resource_path_index message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritoryAssignNotSupported: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - NOT_SUPPORTED details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: resource_path_index: format: int32 type: integer description: Index in the resource path where the error occurred. required: - resource_path_index message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritoryAssignDuplicateData: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - DUPLICATE_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritoryAssignNoPermission: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - NO_PERMISSION details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritorySchedueledSuccessCode: type: object properties: data: type: array maxItems: 100 items: type: object properties: code: type: string enum: - SCHEDULED description: Status code indicating the result of the operation (e.g., SCHEDULED). details: type: object description: Additional information about the created territory. properties: id: format: string type: string description: Unique identifier of the created territory. job_id: format: string type: string description: Unique identifier of the scheduled job. required: - id - job_id additionalProperties: false message: format: string type: string description: Human-readable message describing the outcome of the operation. status: type: string description: Indicates whether the operation succeeded or failed. enum: - success - failure - error required: - code - details - message - status description: Details of each territory operation. additionalProperties: false description: The `data` property. required: - data description: A `object` value. additionalProperties: false TerritoryAssignMandatoryNotFound: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - MANDATORY_NOT_FOUND details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data NotSupportedForRemoveTerritoryRecord: title: Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - NOT_ALLOWED details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritoryInternalServerErrorSchema: type: object properties: code: type: string enum: - INTERNAL_SERVER_ERROR description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false TerritoryAssignAlreadyUsed: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - ALREADY_USED details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritoryAssignRecordLocked: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - RECORD_LOCKED details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: action: format: string type: string description: The API field name associated with the validation error. enum: - record_locking required: - action message: format: string type: string enum: - Sorry, you cannot perform this operation as the record is locked. description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TerritoryLimitExceededErrorSchema: type: object properties: code: type: string enum: - LIMIT_EXCEEDED description: The `code` property. details: oneOf: - type: object properties: limit: type: integer format: int32 description: The `limit` property. required: - limit description: A `object` value. additionalProperties: false - type: object properties: api_name: type: string description: The `api_name` property. maxLength: 100 json_path: type: string description: The `json_path` property. maxLength: 100 limit: type: integer format: int32 description: The `limit` property. required: - api_name - json_path - limit description: A `object` value. additionalProperties: false description: The `details` property. message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false TerritoryAssignInvalidDataMaxLen: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 maximum_length: format: int32 type: integer description: Index in the resource path where the error occurred. required: - api_name - json_path - maximum_length message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - message - details - status InvalidModule: type: object properties: code: type: string enum: - INVALID_MODULE description: The `code` property. details: type: object description: The `details` property. properties: resource_path_index: format: int32 type: integer description: Index in the resource path where the error occurred. required: - resource_path_index additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false TerritoryErrorPermissionDenied: type: object properties: code: type: string enum: - FEATURE_NOT_ENABLED - TERRITORY_DISABLED - TERRITORY_NOT_ENABLED description: The `code` property. details: type: object description: The `details` property. additionalProperties: false message: type: string description: The `message` property. maxLength: 100 status: type: string enum: - error description: The `status` property. required: - code - details - message - status description: A `object` value. additionalProperties: false TerritoryAssignInvalidDataTerritoryId: title: Record - Territory Error Response description: Schema for error responses returned during territory creation or update. type: object additionalProperties: false properties: data: type: array description: List of territories with their validation or processing status. maxItems: 1 items: type: object additionalProperties: false properties: code: type: string description: Error or status code representing the outcome of the request. enum: - INVALID_DATA details: type: object description: Additional contextual information about the error or status. additionalProperties: false properties: api_name: format: string type: string description: The API field name associated with the validation error. minLength: 1 json_path: format: string type: string description: JSON path pointing to the field that caused the issue. minLength: 1 required: - api_name - json_path message: format: string type: string description: Detailed error message to help fix the validation issue. status: type: string description: Indicates whether the operation failed or succeeded. enum: - error - success - failure required: - code - details - message - status description: Details of each territory error. required: - data TagsNested1: type: object additionalProperties: false description: Nested schema for tags properties: name: type: string description: tag name maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 color_code: type: - string - 'null' description: tag color maxLength: 255 PostaddtagsResponse200: type: object additionalProperties: false description: success response when tags associated successfully to records properties: ids: maxLength: 102 type: string description: record ids over_write: type: boolean description: over write tags value data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested' maxItems: 20 locked_count: type: string description: 'Field: locked_count' maxLength: 255 success_count: type: string description: 'Field: success_count' maxLength: 255 tags: maxLength: 255 type: string description: root key MappingMismatchErrorResponse: type: object additionalProperties: false description: When tag given in invalid data type properties: code: type: string description: Error code enum: - MAPPING_MISMATCH details: type: object additionalProperties: false description: Error details with validation information properties: mapped_field: type: object additionalProperties: false description: Error mapped_field with validation information properties: api_name: type: string description: 'mapped_field field: api_name' maxLength: 255 json_path: type: string description: 'mapped_field field: json_path' maxLength: 1000 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 - json_path message: type: string description: Error message maxLength: 255 status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PostaddtagsRequest: type: object additionalProperties: false description: Request body schema properties: ids: type: - string - 'null' description: record ids enum: - '["3060320000002538026"]' maxLength: 102 over_write: type: - boolean - 'null' description: tag over write true false value tags: type: array description: root key (Required) items: $ref: '#/components/schemas/TagsNested' maxItems: 3 required: - tags ErrorResponseCore1335454202: type: object additionalProperties: false description: When the given module name is invalid properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - the module name given seems to be invalid status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore356490233: type: object additionalProperties: false description: Auto-generated from ApiDefinition for INVALID_DATA properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' 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 - json_path - maximum_length 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 TagsNested: type: object additionalProperties: false description: root key properties: name: type: - string - 'null' description: tag name maxLength: 25 modified_time: type: - string - 'null' format: date-time description: merged time maxLength: 25 color_code: type: - string - 'null' description: tag color maxLength: 7 conflict_id: type: - string - 'null' description: merged tag id maxLength: 19 ErrorResponseCore2107518198: type: object additionalProperties: false description: When we try to associate tag for locked record properties: code: type: string description: Error code enum: - RECORD_LOCKED details: type: object additionalProperties: false description: Error details with validation information properties: action: type: string description: 'Detail field: action' maxLength: 255 id: type: string description: 'Detail field: id' maxLength: 255 required: - action - id message: type: string description: Error message enum: - Sorry, you cannot perform this operation as the record is locked. status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1875045219: type: object additionalProperties: false description: When invalid request method is given properties: code: type: string description: Error code enum: - INVALID_REQUEST_METHOD details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - The http request method type is not a valid one status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore833637355: type: object additionalProperties: false description: When tag given in invalid data type 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 - json_path message: type: string description: Error message enum: - invalid data - invalid tag id status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore1799630392: type: object additionalProperties: false description: 'Invalid data type for field: tags' properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object additionalProperties: false description: Error details with validation information properties: maximum_length: type: integer format: int32 description: 'Detail field: maximum_length' api_name: type: string description: 'Detail field: api_name' maxLength: 255 json_path: type: string description: 'Detail field: json_path' maxLength: 1000 expected_data_type: type: string description: 'Detail field: expected_data_type' maxLength: 255 required: - api_name - json_path message: type: string description: Error message maxLength: 255 status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core PostremovetagsRequest: type: object additionalProperties: false description: Request body schema properties: ids: type: - string - 'null' description: record ids enum: - '["3060320000002496003"]' maxLength: 99 tags: type: array description: root key (Required) items: $ref: '#/components/schemas/TagsNested' maxItems: 1 required: - tags ErrorResponseCore1161913208: type: object additionalProperties: false description: When permission doesn't exists properties: code: type: string description: Error code enum: - NO_PERMISSION details: type: object additionalProperties: false description: Error details with validation information properties: permissions: type: array description: 'Detail field: permissions' items: type: string description: 'Detail Field: permissions' maxLength: 255 maxItems: 25 required: - permissions message: type: string description: Error message enum: - permission denied status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore94581445: type: object additionalProperties: false description: 'Missing required parameter: module' properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING details: type: object additionalProperties: false description: Error details with validation information properties: param_name: type: string description: 'Detail field: param_name' maxLength: 255 required: - param_name message: type: string description: Error message enum: - One of the expected param is missing status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core TagErrorItemResponse: type: object description: Error object for individual tag failures additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message enum: - Invalid data - Invalid data type - invalid data status: type: string description: Error status enum: - error details: type: object description: Error details additionalProperties: true required: - code - message - status - details DetailsNested_3: type: object additionalProperties: false description: Nested schema for details properties: modifiedTime: type: string description: Last modified time of the record maxLength: 255 id: type: string description: 'Field: id' maxLength: 255 affected_data: type: 'null' description: 'Field: affected_data' tags: type: array description: 'Field: tags' items: $ref: '#/components/schemas/TagsNested1' maxItems: 10 DataNested: type: object additionalProperties: false description: Nested schema for data properties: code: type: string description: 'Field: code' maxLength: 255 details: $ref: '#/components/schemas/DetailsNested_3' message: type: string description: 'Field: message' maxLength: 255 status: type: string description: 'Field: status' maxLength: 255 PostremovetagsResponse200: type: object additionalProperties: false description: success response when tags removed from records successfully properties: data: type: array description: 'Field: data' items: $ref: '#/components/schemas/DataNested' maxItems: 20 locked_count: type: string description: 'Field: locked_count' maxLength: 255 ErrorResponseCore1273605641: type: object additionalProperties: false description: When the module name is valid but that doesn't have tags support properties: code: type: string description: Error code enum: - INVALID_MODULE details: type: object additionalProperties: false description: Error details with validation information properties: {} message: type: string description: Error message enum: - the given module is not supported for this api status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core ErrorResponseCore239878082: type: object additionalProperties: false description: Auto-generated from ApiDefinition for 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 type status: type: string description: Error status enum: - error required: - code - details - message - status title: Error Response Core responses: BadRequest: description: Bad request. content: application/json: schema: oneOf: - $ref: '#/components/schemas/ErrorResponse_3' - type: object description: Wrapped error responses. additionalProperties: false properties: watch: type: array description: List of error entries. maxItems: 50 items: $ref: '#/components/schemas/ErrorResponse_3' TooManyRequests: description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' MultiStatus: description: Partial success in creating notification channels. content: application/json: schema: type: object description: Partial creation results wrapper. additionalProperties: false properties: watch: type: array description: List of create result entries (success and failure). maxItems: 50 items: oneOf: - type: object description: Single successful create result. additionalProperties: false properties: code: type: string description: Result code. enum: - SUCCESS details: type: object description: Created event channel details. additionalProperties: true message: type: string description: Result message. maxLength: 255 status: type: string description: Status string. enum: - success - $ref: '#/components/schemas/ErrorResponse_3' Unauthorized: description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' InternalServerError: description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse_3' InternalServerError_2: description: Internal Server Error content: application/json: schema: type: object description: Internal server error response object containing code, message, details, and status. additionalProperties: false properties: code: type: string description: Error code indicating the type of error. maxLength: 500 message: type: string description: Human-readable error message. maxLength: 500 details: type: object description: Additional details about the error. additionalProperties: true status: type: string description: Status of the error response. enum: - error required: - code - message - details - status NoContentResponse: description: No record found for the specified record id UnauthorizedError: description: Unauthorized. The request requires valid authentication or a valid OAuth scope. content: application/json: schema: description: Unauthorized error response containing authentication failure or OAuth scope mismatch details. oneOf: - type: object description: Authentication failure response additionalProperties: false properties: code: type: string enum: - AUTHENTICATION_FAILURE description: Error code indicating authentication failure. details: type: object description: Additional details about the error. additionalProperties: true message: type: string description: A message describing the authentication failure. maxLength: 500 status: type: string description: The status of the response. enum: - error required: - code - details - message - status - type: object description: OAuth scope mismatch response additionalProperties: false properties: code: type: string enum: - OAUTH_SCOPE_MISMATCH description: Error code indicating the OAuth scope mismatch. details: type: object description: Additional details about the error. additionalProperties: true message: type: string description: A message describing the OAuth scope mismatch. maxLength: 500 status: type: string description: The status of the response. enum: - error required: - code - details - message - status securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter